8.2 Inventory Management
Last updated
Was this helpful?
Last updated
Was this helpful?
Since inventory is a provider-centric feature, it does not interface with a customer. However, it is called by other services like quotation management, order management, and fulfillment management services.
Consumer Interface declares the customer's intent to buy/avail products or services
/search
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. <ol><li>Demographic information about the transaction using fields like domain, country, and region.</li><li>Addressing details like the sending and receiving platform's ID and API URL.</li><li>Interoperability information like the protocol version that implemented by the sender and,</li><li>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.</li></ol> 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,
curl -L \
--request POST \
--url 'https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/search' \
--header 'Content-Type: application/json' \
--data '{
"message": {
"intent": {
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"provider": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"category_id": "text",
"rating": "text",
"time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"exp": "2025-03-03T14:29:50.799Z",
"rateable": true,
"ttl": 1,
"categories": [
{
"id": "text",
"parent_category_id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"ttl": null,
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
]
}
],
"fulfillments": [
{
"id": "text",
"type": "text",
"rateable": true,
"tracking": false,
"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"
},
"path": "text",
"stops": [
{
"id": "text",
"parent_stop_id": "text",
"type": "text",
"authorization": {
"type": "text",
"token": "text",
"valid_from": "2025-03-03T14:29:50.799Z",
"valid_to": "2025-03-03T14:29:50.799Z",
"status": "text"
},
"location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"map_url": "https://example.com",
"district": "text",
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"polygon": "text",
"3dspace": "text",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"rating": "text"
},
"time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"instructions": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
},
"dob": "2025-03-03",
"gender": "text",
"creds": [
{
"id": "text",
"type": "VerifiableCredential",
"url": "https://example.com"
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"age": "text",
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
]
}
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"rating": "text",
"state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"updated_at": "2025-03-03T14:29:50.799Z",
"updated_by": "text"
},
"customer": {
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
},
"dob": "2025-03-03",
"gender": "text",
"creds": [
{
"id": "text",
"type": "VerifiableCredential",
"url": "https://example.com"
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"age": "text",
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
]
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"agent": {
"id": "text",
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
},
"dob": "2025-03-03",
"gender": "text",
"creds": [
{
"id": "text",
"type": "VerifiableCredential",
"url": "https://example.com"
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"age": "text",
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
]
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"organization": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
}
},
"rating": "text"
}
}
],
"payments": [
{
"id": "text",
"collected_by": null,
"url": "https://example.com",
"time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"type": "PRE-ORDER",
"status": "PAID",
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"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"
}
}
],
"locations": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"map_url": "https://example.com",
"district": "text",
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"polygon": "text",
"3dspace": "text",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"rating": "text"
}
],
"offers": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"location_ids": [
"text"
],
"category_ids": [
"text"
],
"item_ids": [
"text"
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
]
}
],
"items": [
{
"id": "text",
"rateable": true,
"matched": true,
"related": true,
"recommended": true,
"ttl": "text",
"add_ons": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"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": [
{
"reason_required": true,
"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",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
},
"fulfillment_state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"updated_at": "2025-03-03T14:29:50.799Z",
"updated_by": "text"
},
"cancel_by": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
],
"replacement_terms": [
{
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
},
"fulfillment_state": {
"name": "text",
"code": "text"
},
"replace_within": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
],
"return_terms": [
{
"return_eligible": true,
"fulfillment_managed_by": "CONSUMER",
"fulfillment_state": {
"name": "text",
"code": "text"
},
"return_time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"return_location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"map_url": "https://example.com",
"district": "text",
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"polygon": "text",
"3dspace": "text",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"rating": "text"
}
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"parent_item_id": "text",
"parent_item_quantity": {
"allocated": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"available": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"maximum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"minimum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"selected": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"unitized": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
}
},
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"creator": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
}
},
"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": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"available": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"maximum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"minimum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"selected": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"unitized": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
}
},
"xinput": {
"id": "text",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
},
"time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"rating": "text",
"category_ids": [
"text"
],
"fulfillment_ids": [
"text"
],
"location_ids": [
"text"
],
"payment_ids": [
"text"
],
"refund_terms": [
{
"refund_eligible": true,
"refund_amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
},
"fulfillment_state": {
"name": "text",
"code": "text"
},
"refund_within": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
]
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
]
},
"fulfillment": {
"id": "text",
"type": "text",
"rateable": true,
"tracking": false,
"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"
},
"path": "text",
"stops": [
{
"id": "text",
"parent_stop_id": "text",
"type": "text",
"authorization": {
"type": "text",
"token": "text",
"valid_from": "2025-03-03T14:29:50.799Z",
"valid_to": "2025-03-03T14:29:50.799Z",
"status": "text"
},
"location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"map_url": "https://example.com",
"district": "text",
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"polygon": "text",
"3dspace": "text",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"rating": "text"
},
"time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"instructions": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
},
"dob": "2025-03-03",
"gender": "text",
"creds": [
{
"id": "text",
"type": "VerifiableCredential",
"url": "https://example.com"
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"age": "text",
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
]
}
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"rating": "text",
"state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"updated_at": "2025-03-03T14:29:50.799Z",
"updated_by": "text"
},
"customer": {
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
},
"dob": "2025-03-03",
"gender": "text",
"creds": [
{
"id": "text",
"type": "VerifiableCredential",
"url": "https://example.com"
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"age": "text",
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
]
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"agent": {
"id": "text",
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
},
"dob": "2025-03-03",
"gender": "text",
"creds": [
{
"id": "text",
"type": "VerifiableCredential",
"url": "https://example.com"
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"age": "text",
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
]
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"organization": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
}
},
"rating": "text"
}
},
"payment": {
"id": "text",
"collected_by": null,
"url": "https://example.com",
"time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"type": "PRE-ORDER",
"status": "PAID",
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"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"
}
},
"category": {
"id": "text",
"parent_category_id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"ttl": null,
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
]
},
"offer": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"location_ids": [
"text"
],
"category_ids": [
"text"
],
"item_ids": [
"text"
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
]
},
"item": {
"id": "text",
"rateable": true,
"matched": true,
"related": true,
"recommended": true,
"ttl": "text",
"add_ons": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"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": [
{
"reason_required": true,
"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",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
},
"fulfillment_state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"updated_at": "2025-03-03T14:29:50.799Z",
"updated_by": "text"
},
"cancel_by": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
],
"replacement_terms": [
{
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
},
"fulfillment_state": {
"name": "text",
"code": "text"
},
"replace_within": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
],
"return_terms": [
{
"return_eligible": true,
"fulfillment_managed_by": "CONSUMER",
"fulfillment_state": {
"name": "text",
"code": "text"
},
"return_time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"return_location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"map_url": "https://example.com",
"district": "text",
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"polygon": "text",
"3dspace": "text",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"rating": "text"
}
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"parent_item_id": "text",
"parent_item_quantity": {
"allocated": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"available": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"maximum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"minimum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"selected": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"unitized": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
}
},
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"creator": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
}
},
"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": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"available": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"maximum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"minimum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"selected": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"unitized": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
}
},
"xinput": {
"id": "text",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
},
"time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"rating": "text",
"category_ids": [
"text"
],
"fulfillment_ids": [
"text"
],
"location_ids": [
"text"
],
"payment_ids": [
"text"
],
"refund_terms": [
{
"refund_eligible": true,
"refund_amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
},
"fulfillment_state": {
"name": "text",
"code": "text"
},
"refund_within": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
]
}
}
},
"context": {
"action": "search",
"version": "text",
"transaction_id": "123e4567-e89b-12d3-a456-426614174000",
"message_id": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-03-03T14:29:50.799Z",
"key": "text",
"ttl": "text",
"domain": {},
"location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"map_url": "https://example.com",
"district": "text",
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"polygon": "text",
"3dspace": "text",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"rating": "text"
},
"bap_id": "text",
"bap_uri": "https://example.com",
"bpp_id": "text",
"bpp_uri": "https://example.com"
}
}'{
"error": {
"code": "text",
"paths": "text",
"message": "text"
},
"message": {
"ack": {
"status": "ACK",
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
]
}
}
}Acknowledgement of message received after successful validation of schema and signature
Check availability of a resource in an inventory
/inventory/checkAvailability/{resource}//{id}
Name of the resource
Item, AddOnID of the Resource
ID of the item.
curl -L \
--url 'https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/inventory/checkAvailability/{resource}/{id}'{
"id": "text",
"rateable": true,
"matched": true,
"related": true,
"recommended": true,
"ttl": "text",
"add_ons": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"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": [
{
"reason_required": true,
"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",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
},
"fulfillment_state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"updated_at": "2025-03-03T14:29:50.799Z",
"updated_by": "text"
},
"cancel_by": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
],
"replacement_terms": [
{
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
},
"fulfillment_state": {
"name": "text",
"code": "text"
},
"replace_within": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
],
"return_terms": [
{
"return_eligible": true,
"fulfillment_managed_by": "CONSUMER",
"fulfillment_state": {
"name": "text",
"code": "text"
},
"return_time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"return_location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"map_url": "https://example.com",
"district": "text",
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"polygon": "text",
"3dspace": "text",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"rating": "text"
}
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"parent_item_id": "text",
"parent_item_quantity": {
"allocated": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"available": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"maximum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"minimum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"selected": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"unitized": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
}
},
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"creator": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
}
},
"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": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"available": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"maximum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"minimum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"selected": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"unitized": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
}
},
"xinput": {
"id": "text",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
},
"time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"rating": "text",
"category_ids": [
"text"
],
"fulfillment_ids": [
"text"
],
"location_ids": [
"text"
],
"payment_ids": [
"text"
],
"refund_terms": [
{
"refund_eligible": true,
"refund_amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
},
"fulfillment_state": {
"name": "text",
"code": "text"
},
"refund_within": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
]
}Successful fetch of resources from the catalog
Add Item to inventory
/inventory/item/add
ID of the item.
Whether this item can be rated
Whether this item is an exact match of the request
Whether this item is a related item to the exactly matched item
Whether this item is a recommended item to a response
Time to live in seconds for an instance of this schema
Describes an additional item offered as a value-addition to a product or service. This does not exist independently in a catalog and is always associated with an item.
Describes the cancellation terms of an item or an order. This can be referenced at an item or order level. Item-level cancellation terms can override the terms at the order level.
The replacement policy of an item or an order
Describes the return policy of an item or an order
A collection of tag objects with group level attributes. For detailed documentation on the Tags and Tag Groups schema go to https://github.com/beckn/protocol-specifications/discussions/316
ID of the item, this item is a variant of
ID of the item.
The number of units of the parent item this item is a multiple of
Describes the count or amount of an item
Physical description of the item
Physical description of something.
The creator of this item
An organization. Usually a recognized business entity.
The price of this item, if it has intrinsic value
Describes the price of a product or service
The selling quantity of the item
Describes the count or amount of an item
Additional input required from the customer to purchase / avail this item
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.
Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.
Describes time in its various forms. It can be a single point in time; duration; or a structured timetable of operations<br>This has properties like label, time stamp,duration,range, days, schedule
The rating of the item
Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.
Refund term of an item or an order
curl -L \
--request POST \
--url 'https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/inventory/item/add' \
--header 'Content-Type: application/json' \
--data '{
"id": "text",
"rateable": true,
"matched": true,
"related": true,
"recommended": true,
"ttl": "text",
"add_ons": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"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": [
{
"reason_required": true,
"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",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
},
"fulfillment_state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"updated_at": "2025-03-03T14:29:50.799Z",
"updated_by": "text"
},
"cancel_by": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
],
"replacement_terms": [
{
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
},
"fulfillment_state": {
"name": "text",
"code": "text"
},
"replace_within": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
],
"return_terms": [
{
"return_eligible": true,
"fulfillment_managed_by": "CONSUMER",
"fulfillment_state": {
"name": "text",
"code": "text"
},
"return_time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"return_location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"map_url": "https://example.com",
"district": "text",
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"polygon": "text",
"3dspace": "text",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"rating": "text"
}
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"parent_item_id": "text",
"parent_item_quantity": {
"allocated": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"available": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"maximum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"minimum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"selected": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"unitized": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
}
},
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"creator": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
}
},
"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": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"available": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"maximum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"minimum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"selected": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"unitized": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
}
},
"xinput": {
"id": "text",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
},
"time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"rating": "text",
"category_ids": [
"text"
],
"fulfillment_ids": [
"text"
],
"location_ids": [
"text"
],
"payment_ids": [
"text"
],
"refund_terms": [
{
"refund_eligible": true,
"refund_amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
},
"fulfillment_state": {
"name": "text",
"code": "text"
},
"refund_within": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
]
}'{
"id": "text",
"rateable": true,
"matched": true,
"related": true,
"recommended": true,
"ttl": "text",
"add_ons": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"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": [
{
"reason_required": true,
"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",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
},
"fulfillment_state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"updated_at": "2025-03-03T14:29:50.799Z",
"updated_by": "text"
},
"cancel_by": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
],
"replacement_terms": [
{
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
},
"fulfillment_state": {
"name": "text",
"code": "text"
},
"replace_within": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
],
"return_terms": [
{
"return_eligible": true,
"fulfillment_managed_by": "CONSUMER",
"fulfillment_state": {
"name": "text",
"code": "text"
},
"return_time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"return_location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"map_url": "https://example.com",
"district": "text",
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"polygon": "text",
"3dspace": "text",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"rating": "text"
}
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"parent_item_id": "text",
"parent_item_quantity": {
"allocated": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"available": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"maximum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"minimum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"selected": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"unitized": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
}
},
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"creator": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
}
},
"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": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"available": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"maximum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"minimum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"selected": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"unitized": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
}
},
"xinput": {
"id": "text",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
},
"time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"rating": "text",
"category_ids": [
"text"
],
"fulfillment_ids": [
"text"
],
"location_ids": [
"text"
],
"payment_ids": [
"text"
],
"refund_terms": [
{
"refund_eligible": true,
"refund_amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
},
"fulfillment_state": {
"name": "text",
"code": "text"
},
"refund_within": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
]
}Successful fetch of resources from the catalog
Remove Item from inventory
/inventory/item/remove
ID of the item.
Whether this item can be rated
Whether this item is an exact match of the request
Whether this item is a related item to the exactly matched item
Whether this item is a recommended item to a response
Time to live in seconds for an instance of this schema
Describes an additional item offered as a value-addition to a product or service. This does not exist independently in a catalog and is always associated with an item.
Describes the cancellation terms of an item or an order. This can be referenced at an item or order level. Item-level cancellation terms can override the terms at the order level.
The replacement policy of an item or an order
Describes the return policy of an item or an order
A collection of tag objects with group level attributes. For detailed documentation on the Tags and Tag Groups schema go to https://github.com/beckn/protocol-specifications/discussions/316
ID of the item, this item is a variant of
ID of the item.
The number of units of the parent item this item is a multiple of
Describes the count or amount of an item
Physical description of the item
Physical description of something.
The creator of this item
An organization. Usually a recognized business entity.
The price of this item, if it has intrinsic value
Describes the price of a product or service
The selling quantity of the item
Describes the count or amount of an item
Additional input required from the customer to purchase / avail this item
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.
Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.
Describes time in its various forms. It can be a single point in time; duration; or a structured timetable of operations<br>This has properties like label, time stamp,duration,range, days, schedule
The rating of the item
Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.
Refund term of an item or an order
curl -L \
--request POST \
--url 'https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/inventory/item/remove' \
--header 'Content-Type: application/json' \
--data '{
"id": "text",
"rateable": true,
"matched": true,
"related": true,
"recommended": true,
"ttl": "text",
"add_ons": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"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": [
{
"reason_required": true,
"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",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
},
"fulfillment_state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"updated_at": "2025-03-03T14:29:50.799Z",
"updated_by": "text"
},
"cancel_by": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
],
"replacement_terms": [
{
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
},
"fulfillment_state": {
"name": "text",
"code": "text"
},
"replace_within": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
],
"return_terms": [
{
"return_eligible": true,
"fulfillment_managed_by": "CONSUMER",
"fulfillment_state": {
"name": "text",
"code": "text"
},
"return_time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"return_location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"map_url": "https://example.com",
"district": "text",
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"polygon": "text",
"3dspace": "text",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"rating": "text"
}
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"parent_item_id": "text",
"parent_item_quantity": {
"allocated": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"available": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"maximum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"minimum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"selected": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"unitized": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
}
},
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"creator": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
}
},
"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": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"available": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"maximum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"minimum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"selected": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"unitized": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
}
},
"xinput": {
"id": "text",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
},
"time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"rating": "text",
"category_ids": [
"text"
],
"fulfillment_ids": [
"text"
],
"location_ids": [
"text"
],
"payment_ids": [
"text"
],
"refund_terms": [
{
"refund_eligible": true,
"refund_amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
},
"fulfillment_state": {
"name": "text",
"code": "text"
},
"refund_within": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
]
}'{
"id": "text",
"rateable": true,
"matched": true,
"related": true,
"recommended": true,
"ttl": "text",
"add_ons": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"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": [
{
"reason_required": true,
"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",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
},
"fulfillment_state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"updated_at": "2025-03-03T14:29:50.799Z",
"updated_by": "text"
},
"cancel_by": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
],
"replacement_terms": [
{
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
},
"fulfillment_state": {
"name": "text",
"code": "text"
},
"replace_within": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
],
"return_terms": [
{
"return_eligible": true,
"fulfillment_managed_by": "CONSUMER",
"fulfillment_state": {
"name": "text",
"code": "text"
},
"return_time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"return_location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"map_url": "https://example.com",
"district": "text",
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"polygon": "text",
"3dspace": "text",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"rating": "text"
}
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"parent_item_id": "text",
"parent_item_quantity": {
"allocated": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"available": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"maximum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"minimum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"selected": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"unitized": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
}
},
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"creator": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
}
},
"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": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"available": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"maximum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"minimum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"selected": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"unitized": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
}
},
"xinput": {
"id": "text",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
},
"time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"rating": "text",
"category_ids": [
"text"
],
"fulfillment_ids": [
"text"
],
"location_ids": [
"text"
],
"payment_ids": [
"text"
],
"refund_terms": [
{
"refund_eligible": true,
"refund_amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
},
"fulfillment_state": {
"name": "text",
"code": "text"
},
"refund_within": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
]
}Successful fetch of resources from the catalog
Block Item in inventory
/inventory/item/block
ID of the item.
Whether this item can be rated
Whether this item is an exact match of the request
Whether this item is a related item to the exactly matched item
Whether this item is a recommended item to a response
Time to live in seconds for an instance of this schema
Describes an additional item offered as a value-addition to a product or service. This does not exist independently in a catalog and is always associated with an item.
Describes the cancellation terms of an item or an order. This can be referenced at an item or order level. Item-level cancellation terms can override the terms at the order level.
The replacement policy of an item or an order
Describes the return policy of an item or an order
A collection of tag objects with group level attributes. For detailed documentation on the Tags and Tag Groups schema go to https://github.com/beckn/protocol-specifications/discussions/316
ID of the item, this item is a variant of
ID of the item.
The number of units of the parent item this item is a multiple of
Describes the count or amount of an item
Physical description of the item
Physical description of something.
The creator of this item
An organization. Usually a recognized business entity.
The price of this item, if it has intrinsic value
Describes the price of a product or service
The selling quantity of the item
Describes the count or amount of an item
Additional input required from the customer to purchase / avail this item
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.
Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.
Describes time in its various forms. It can be a single point in time; duration; or a structured timetable of operations<br>This has properties like label, time stamp,duration,range, days, schedule
The rating of the item
Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.
Refund term of an item or an order
curl -L \
--request POST \
--url 'https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/inventory/item/block' \
--header 'Content-Type: application/json' \
--data '{
"id": "text",
"rateable": true,
"matched": true,
"related": true,
"recommended": true,
"ttl": "text",
"add_ons": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"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": [
{
"reason_required": true,
"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",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
},
"fulfillment_state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"updated_at": "2025-03-03T14:29:50.799Z",
"updated_by": "text"
},
"cancel_by": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
],
"replacement_terms": [
{
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
},
"fulfillment_state": {
"name": "text",
"code": "text"
},
"replace_within": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
],
"return_terms": [
{
"return_eligible": true,
"fulfillment_managed_by": "CONSUMER",
"fulfillment_state": {
"name": "text",
"code": "text"
},
"return_time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"return_location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"map_url": "https://example.com",
"district": "text",
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"polygon": "text",
"3dspace": "text",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"rating": "text"
}
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"parent_item_id": "text",
"parent_item_quantity": {
"allocated": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"available": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"maximum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"minimum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"selected": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"unitized": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
}
},
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"creator": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
}
},
"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": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"available": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"maximum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"minimum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"selected": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"unitized": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
}
},
"xinput": {
"id": "text",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
},
"time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"rating": "text",
"category_ids": [
"text"
],
"fulfillment_ids": [
"text"
],
"location_ids": [
"text"
],
"payment_ids": [
"text"
],
"refund_terms": [
{
"refund_eligible": true,
"refund_amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
},
"fulfillment_state": {
"name": "text",
"code": "text"
},
"refund_within": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
]
}'{
"id": "text",
"rateable": true,
"matched": true,
"related": true,
"recommended": true,
"ttl": "text",
"add_ons": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"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": [
{
"reason_required": true,
"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",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
},
"fulfillment_state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"updated_at": "2025-03-03T14:29:50.799Z",
"updated_by": "text"
},
"cancel_by": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
],
"replacement_terms": [
{
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
},
"fulfillment_state": {
"name": "text",
"code": "text"
},
"replace_within": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
],
"return_terms": [
{
"return_eligible": true,
"fulfillment_managed_by": "CONSUMER",
"fulfillment_state": {
"name": "text",
"code": "text"
},
"return_time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"return_location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"map_url": "https://example.com",
"district": "text",
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"polygon": "text",
"3dspace": "text",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"rating": "text"
}
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"parent_item_id": "text",
"parent_item_quantity": {
"allocated": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"available": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"maximum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"minimum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"selected": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"unitized": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
}
},
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"creator": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
}
},
"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": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"available": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"maximum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"minimum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"selected": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"unitized": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
}
},
"xinput": {
"id": "text",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
},
"time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"rating": "text",
"category_ids": [
"text"
],
"fulfillment_ids": [
"text"
],
"location_ids": [
"text"
],
"payment_ids": [
"text"
],
"refund_terms": [
{
"refund_eligible": true,
"refund_amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
},
"fulfillment_state": {
"name": "text",
"code": "text"
},
"refund_within": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
]
}Successful fetch of resources from the catalog
Unblock addOn in inventory
/inventory/addOn/unblock
ID of the item.
Whether this item can be rated
Whether this item is an exact match of the request
Whether this item is a related item to the exactly matched item
Whether this item is a recommended item to a response
Time to live in seconds for an instance of this schema
Describes an additional item offered as a value-addition to a product or service. This does not exist independently in a catalog and is always associated with an item.
Describes the cancellation terms of an item or an order. This can be referenced at an item or order level. Item-level cancellation terms can override the terms at the order level.
The replacement policy of an item or an order
Describes the return policy of an item or an order
A collection of tag objects with group level attributes. For detailed documentation on the Tags and Tag Groups schema go to https://github.com/beckn/protocol-specifications/discussions/316
ID of the item, this item is a variant of
ID of the item.
The number of units of the parent item this item is a multiple of
Describes the count or amount of an item
Physical description of the item
Physical description of something.
The creator of this item
An organization. Usually a recognized business entity.
The price of this item, if it has intrinsic value
Describes the price of a product or service
The selling quantity of the item
Describes the count or amount of an item
Additional input required from the customer to purchase / avail this item
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.
Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.
Describes time in its various forms. It can be a single point in time; duration; or a structured timetable of operations<br>This has properties like label, time stamp,duration,range, days, schedule
The rating of the item
Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.
Refund term of an item or an order
curl -L \
--request POST \
--url 'https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/inventory/addOn/unblock' \
--header 'Content-Type: application/json' \
--data '{
"id": "text",
"rateable": true,
"matched": true,
"related": true,
"recommended": true,
"ttl": "text",
"add_ons": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"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": [
{
"reason_required": true,
"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",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
},
"fulfillment_state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"updated_at": "2025-03-03T14:29:50.799Z",
"updated_by": "text"
},
"cancel_by": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
],
"replacement_terms": [
{
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
},
"fulfillment_state": {
"name": "text",
"code": "text"
},
"replace_within": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
],
"return_terms": [
{
"return_eligible": true,
"fulfillment_managed_by": "CONSUMER",
"fulfillment_state": {
"name": "text",
"code": "text"
},
"return_time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"return_location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"map_url": "https://example.com",
"district": "text",
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"polygon": "text",
"3dspace": "text",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"rating": "text"
}
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"parent_item_id": "text",
"parent_item_quantity": {
"allocated": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"available": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"maximum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"minimum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"selected": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"unitized": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
}
},
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"creator": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
}
},
"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": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"available": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"maximum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"minimum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"selected": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"unitized": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
}
},
"xinput": {
"id": "text",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
},
"time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"rating": "text",
"category_ids": [
"text"
],
"fulfillment_ids": [
"text"
],
"location_ids": [
"text"
],
"payment_ids": [
"text"
],
"refund_terms": [
{
"refund_eligible": true,
"refund_amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
},
"fulfillment_state": {
"name": "text",
"code": "text"
},
"refund_within": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
]
}'{
"id": "text",
"rateable": true,
"matched": true,
"related": true,
"recommended": true,
"ttl": "text",
"add_ons": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"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": [
{
"reason_required": true,
"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",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
},
"fulfillment_state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"updated_at": "2025-03-03T14:29:50.799Z",
"updated_by": "text"
},
"cancel_by": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
],
"replacement_terms": [
{
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
},
"fulfillment_state": {
"name": "text",
"code": "text"
},
"replace_within": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
],
"return_terms": [
{
"return_eligible": true,
"fulfillment_managed_by": "CONSUMER",
"fulfillment_state": {
"name": "text",
"code": "text"
},
"return_time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"return_location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"map_url": "https://example.com",
"district": "text",
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"polygon": "text",
"3dspace": "text",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"rating": "text"
}
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"parent_item_id": "text",
"parent_item_quantity": {
"allocated": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"available": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"maximum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"minimum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"selected": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"unitized": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
}
},
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"creator": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
}
},
"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": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"available": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"maximum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"minimum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"selected": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"unitized": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
}
},
"xinput": {
"id": "text",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
},
"time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"rating": "text",
"category_ids": [
"text"
],
"fulfillment_ids": [
"text"
],
"location_ids": [
"text"
],
"payment_ids": [
"text"
],
"refund_terms": [
{
"refund_eligible": true,
"refund_amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
},
"fulfillment_state": {
"name": "text",
"code": "text"
},
"refund_within": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
]
}Successful fetch of resources from the catalog
Block add-on in inventory
/inventory/addOn/block
ID of the item.
Whether this item can be rated
Whether this item is an exact match of the request
Whether this item is a related item to the exactly matched item
Whether this item is a recommended item to a response
Time to live in seconds for an instance of this schema
Describes an additional item offered as a value-addition to a product or service. This does not exist independently in a catalog and is always associated with an item.
Describes the cancellation terms of an item or an order. This can be referenced at an item or order level. Item-level cancellation terms can override the terms at the order level.
The replacement policy of an item or an order
Describes the return policy of an item or an order
A collection of tag objects with group level attributes. For detailed documentation on the Tags and Tag Groups schema go to https://github.com/beckn/protocol-specifications/discussions/316
ID of the item, this item is a variant of
ID of the item.
The number of units of the parent item this item is a multiple of
Describes the count or amount of an item
Physical description of the item
Physical description of something.
The creator of this item
An organization. Usually a recognized business entity.
The price of this item, if it has intrinsic value
Describes the price of a product or service
The selling quantity of the item
Describes the count or amount of an item
Additional input required from the customer to purchase / avail this item
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.
Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.
Describes time in its various forms. It can be a single point in time; duration; or a structured timetable of operations<br>This has properties like label, time stamp,duration,range, days, schedule
The rating of the item
Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.
Refund term of an item or an order
curl -L \
--request POST \
--url 'https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/inventory/addOn/block' \
--header 'Content-Type: application/json' \
--data '{
"id": "text",
"rateable": true,
"matched": true,
"related": true,
"recommended": true,
"ttl": "text",
"add_ons": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"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": [
{
"reason_required": true,
"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",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
},
"fulfillment_state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"updated_at": "2025-03-03T14:29:50.799Z",
"updated_by": "text"
},
"cancel_by": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
],
"replacement_terms": [
{
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
},
"fulfillment_state": {
"name": "text",
"code": "text"
},
"replace_within": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
],
"return_terms": [
{
"return_eligible": true,
"fulfillment_managed_by": "CONSUMER",
"fulfillment_state": {
"name": "text",
"code": "text"
},
"return_time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"return_location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"map_url": "https://example.com",
"district": "text",
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"polygon": "text",
"3dspace": "text",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"rating": "text"
}
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"parent_item_id": "text",
"parent_item_quantity": {
"allocated": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"available": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"maximum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"minimum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"selected": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"unitized": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
}
},
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"creator": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
}
},
"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": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"available": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"maximum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"minimum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"selected": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"unitized": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
}
},
"xinput": {
"id": "text",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
},
"time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"rating": "text",
"category_ids": [
"text"
],
"fulfillment_ids": [
"text"
],
"location_ids": [
"text"
],
"payment_ids": [
"text"
],
"refund_terms": [
{
"refund_eligible": true,
"refund_amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
},
"fulfillment_state": {
"name": "text",
"code": "text"
},
"refund_within": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
]
}'{
"id": "text",
"rateable": true,
"matched": true,
"related": true,
"recommended": true,
"ttl": "text",
"add_ons": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"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": [
{
"reason_required": true,
"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",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
},
"fulfillment_state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"updated_at": "2025-03-03T14:29:50.799Z",
"updated_by": "text"
},
"cancel_by": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
],
"replacement_terms": [
{
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
},
"fulfillment_state": {
"name": "text",
"code": "text"
},
"replace_within": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
],
"return_terms": [
{
"return_eligible": true,
"fulfillment_managed_by": "CONSUMER",
"fulfillment_state": {
"name": "text",
"code": "text"
},
"return_time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"return_location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"map_url": "https://example.com",
"district": "text",
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"polygon": "text",
"3dspace": "text",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"rating": "text"
}
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"parent_item_id": "text",
"parent_item_quantity": {
"allocated": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"available": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"maximum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"minimum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"selected": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"unitized": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
}
},
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"creator": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
}
},
"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": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"available": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"maximum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"minimum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"selected": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"unitized": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
}
},
"xinput": {
"id": "text",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
},
"time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"rating": "text",
"category_ids": [
"text"
],
"fulfillment_ids": [
"text"
],
"location_ids": [
"text"
],
"payment_ids": [
"text"
],
"refund_terms": [
{
"refund_eligible": true,
"refund_amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
},
"fulfillment_state": {
"name": "text",
"code": "text"
},
"refund_within": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
]
}Successful fetch of resources from the catalog
Add Item to inventory
/inventory/item/unblock
ID of the item.
Whether this item can be rated
Whether this item is an exact match of the request
Whether this item is a related item to the exactly matched item
Whether this item is a recommended item to a response
Time to live in seconds for an instance of this schema
Describes an additional item offered as a value-addition to a product or service. This does not exist independently in a catalog and is always associated with an item.
Describes the cancellation terms of an item or an order. This can be referenced at an item or order level. Item-level cancellation terms can override the terms at the order level.
The replacement policy of an item or an order
Describes the return policy of an item or an order
A collection of tag objects with group level attributes. For detailed documentation on the Tags and Tag Groups schema go to https://github.com/beckn/protocol-specifications/discussions/316
ID of the item, this item is a variant of
ID of the item.
The number of units of the parent item this item is a multiple of
Describes the count or amount of an item
Physical description of the item
Physical description of something.
The creator of this item
An organization. Usually a recognized business entity.
The price of this item, if it has intrinsic value
Describes the price of a product or service
The selling quantity of the item
Describes the count or amount of an item
Additional input required from the customer to purchase / avail this item
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.
Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.
Describes time in its various forms. It can be a single point in time; duration; or a structured timetable of operations<br>This has properties like label, time stamp,duration,range, days, schedule
The rating of the item
Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.
Refund term of an item or an order
curl -L \
--request POST \
--url 'https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/inventory/item/unblock' \
--header 'Content-Type: application/json' \
--data '{
"id": "text",
"rateable": true,
"matched": true,
"related": true,
"recommended": true,
"ttl": "text",
"add_ons": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"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": [
{
"reason_required": true,
"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",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
},
"fulfillment_state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"updated_at": "2025-03-03T14:29:50.799Z",
"updated_by": "text"
},
"cancel_by": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
],
"replacement_terms": [
{
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
},
"fulfillment_state": {
"name": "text",
"code": "text"
},
"replace_within": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
],
"return_terms": [
{
"return_eligible": true,
"fulfillment_managed_by": "CONSUMER",
"fulfillment_state": {
"name": "text",
"code": "text"
},
"return_time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"return_location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"map_url": "https://example.com",
"district": "text",
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"polygon": "text",
"3dspace": "text",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"rating": "text"
}
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"parent_item_id": "text",
"parent_item_quantity": {
"allocated": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"available": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"maximum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"minimum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"selected": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"unitized": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
}
},
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"creator": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
}
},
"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": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"available": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"maximum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"minimum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"selected": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"unitized": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
}
},
"xinput": {
"id": "text",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
},
"time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"rating": "text",
"category_ids": [
"text"
],
"fulfillment_ids": [
"text"
],
"location_ids": [
"text"
],
"payment_ids": [
"text"
],
"refund_terms": [
{
"refund_eligible": true,
"refund_amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
},
"fulfillment_state": {
"name": "text",
"code": "text"
},
"refund_within": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
]
}'{
"id": "text",
"rateable": true,
"matched": true,
"related": true,
"recommended": true,
"ttl": "text",
"add_ons": [
{
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"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": [
{
"reason_required": true,
"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",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
},
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
},
"fulfillment_state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"updated_at": "2025-03-03T14:29:50.799Z",
"updated_by": "text"
},
"cancel_by": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
],
"replacement_terms": [
{
"external_ref": {
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
},
"fulfillment_state": {
"name": "text",
"code": "text"
},
"replace_within": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
],
"return_terms": [
{
"return_eligible": true,
"fulfillment_managed_by": "CONSUMER",
"fulfillment_state": {
"name": "text",
"code": "text"
},
"return_time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"return_location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"map_url": "https://example.com",
"district": "text",
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"polygon": "text",
"3dspace": "text",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"rating": "text"
}
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"parent_item_id": "text",
"parent_item_quantity": {
"allocated": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"available": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"maximum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"minimum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"selected": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"unitized": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
}
},
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"creator": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
}
},
"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": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"available": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"maximum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"minimum": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"selected": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"unitized": {
"count": 1,
"measure": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
}
},
"xinput": {
"id": "text",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
},
"time": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
},
"rating": "text",
"category_ids": [
"text"
],
"fulfillment_ids": [
"text"
],
"location_ids": [
"text"
],
"payment_ids": [
"text"
],
"refund_terms": [
{
"refund_eligible": true,
"refund_amount": {
"currency": "text",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"listed_value": "text",
"offered_value": "text",
"minimum_value": "text",
"maximum_value": "text"
},
"fulfillment_state": {
"name": "text",
"code": "text"
},
"refund_within": {
"label": "text",
"timestamp": "2025-03-03T14:29:50.799Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T14:29:50.799Z"
],
"times": [
"2025-03-03T14:29:50.799Z"
]
},
"range": {
"start": "2025-03-03T14:29:50.799Z",
"end": "2025-03-03T14:29:50.799Z"
}
}
}
]
}Successful fetch of resources from the catalog