8.2 Inventory Management

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

POSThttps://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/search

Body

application/json

context*all of

message*object

Response

default

Acknowledgement of message received after successful validation of schema and signature

Body

application/json

message*object

errorobject

Describes an error object that is returned by a Consumer Interface, Provider Platform or BG as a response or callback to an action by another network participant. This object is sent when any request received by a network participant is unacceptable. This object can be sent either during Ack or with the callback.

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "context": {},
      "message": {}
    }),
});
const data = await response.json();

Response

default

{
  "message": {
    "ack": {
      "status": "ACK",
      "tags": [
        {
          "display": true,
          "descriptor": {
            "name": "text",
            "code": "text",
            "short_desc": "text",
            "long_desc": "text",
            "additional_desc": {
              "url": "text",
              "content_type": "text/plain"
            },
            "media": [
              {
                "mimetype": "text",
                "url": "https://example.com",
                "signature": "text",
                "dsa": "text"
              }
            ],
            "images": [
              {
                "url": "https://example.com",
                "size_type": "xs",
                "width": "text",
                "height": "text"
              }
            ]
          },
          "list": [
            {
              "descriptor": {
                "name": "text",
                "code": "text",
                "short_desc": "text",
                "long_desc": "text",
                "additional_desc": {
                  "url": "text",
                  "content_type": "text/plain"
                },
                "media": [
                  {
                    "mimetype": "text",
                    "url": "https://example.com",
                    "signature": "text",
                    "dsa": "text"
                  }
                ],
                "images": [
                  {
                    "url": "https://example.com",
                    "size_type": "xs",
                    "width": "text",
                    "height": "text"
                  }
                ]
              },
              "value": "text",
              "display": false
            }
          ]
        }
      ]
    }
  },
  "error": {
    "code": "text",
    "paths": "text",
    "message": "text"
  }
}

Check availability of a resource in an inventory

GEThttps://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/inventory/checkAvailability/{resource}/{id}

Path parameters

resource*enum

Name of the resource

ItemAddOn

id*one of

ID of the Resource

string

Response

default

Successful fetch of resources from the catalog

Body

application/json

idstring

ID of the item.

parent_item_idall of

ID of the item, this item is a variant of

parent_item_quantityall of

The number of units of the parent item this item is a multiple of

descriptorall of

Physical description of the item

creatorall of

The creator of this item

priceall of

The price of this item, if it has intrinsic value

quantityall of

The selling quantity of the item

category_idsarray of all of

Categories this item can be listed under

fulfillment_idsarray of all of

Modes through which this item can be fulfilled

location_idsarray of all of

Provider Locations this item is available in

payment_idsarray of all of

Payment modalities through which this item can be ordered

add_onsarray of object

cancellation_termsarray of object

Cancellation terms of this item

refund_termsarray of object

Refund terms of this item

replacement_termsarray of object

Terms that are applicable be met when this item is replaced

return_termsarray of object

Terms that are applicable when this item is returned

xinputall of

Additional input required from the customer to purchase / avail this item

timeall of

Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.

rateableboolean

Whether this item can be rated

ratingall of

The rating of the item

matchedboolean

Whether this item is an exact match of the request

relatedboolean

Whether this item is a related item to the exactly matched item

recommendedboolean

Whether this item is a recommended item to a response

ttlstring

Time to live in seconds for an instance of this schema

tagsarray of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/inventory/checkAvailability/{resource}/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

default

{
  "id": "text",
  "parent_item_id": {},
  "parent_item_quantity": {
    "allocated": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "available": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "maximum": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "minimum": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "selected": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "unitized": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    }
  },
  "descriptor": {
    "name": "text",
    "code": "text",
    "short_desc": "text",
    "long_desc": "text",
    "additional_desc": {
      "url": "text",
      "content_type": "text/plain"
    },
    "media": [
      {
        "mimetype": "text",
        "url": "https://example.com",
        "signature": "text",
        "dsa": "text"
      }
    ],
    "images": [
      {
        "url": "https://example.com",
        "size_type": "xs",
        "width": "text",
        "height": "text"
      }
    ]
  },
  "creator": {
    "descriptor": {
      "name": "text",
      "code": "text",
      "short_desc": "text",
      "long_desc": "text",
      "additional_desc": {
        "url": "text",
        "content_type": "text/plain"
      },
      "media": [
        {
          "mimetype": "text",
          "url": "https://example.com",
          "signature": "text",
          "dsa": "text"
        }
      ],
      "images": [
        {
          "url": "https://example.com",
          "size_type": "xs",
          "width": "text",
          "height": "text"
        }
      ]
    },
    "address": {},
    "state": {
      "name": "text",
      "code": "text"
    },
    "city": {
      "name": "text",
      "code": "text"
    },
    "contact": {
      "phone": "text",
      "email": "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": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "available": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "maximum": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "minimum": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "selected": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "unitized": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    }
  },
  "category_ids": [
    {}
  ],
  "fulfillment_ids": [
    {}
  ],
  "location_ids": [
    {}
  ],
  "payment_ids": [
    {}
  ],
  "add_ons": [
    {
      "id": "text",
      "descriptor": {
        "name": "text",
        "code": "text",
        "short_desc": "text",
        "long_desc": "text",
        "additional_desc": {
          "url": "text",
          "content_type": "text/plain"
        },
        "media": [
          {
            "mimetype": "text",
            "url": "https://example.com",
            "signature": "text",
            "dsa": "text"
          }
        ],
        "images": [
          {
            "url": "https://example.com",
            "size_type": "xs",
            "width": "text",
            "height": "text"
          }
        ]
      },
      "price": {
        "currency": "text",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "listed_value": "text",
        "offered_value": "text",
        "minimum_value": "text",
        "maximum_value": "text"
      }
    }
  ],
  "cancellation_terms": [
    {
      "fulfillment_state": {
        "descriptor": {
          "name": "text",
          "code": "text",
          "short_desc": "text",
          "long_desc": "text",
          "additional_desc": {
            "url": "text",
            "content_type": "text/plain"
          },
          "media": [
            {
              "mimetype": "text",
              "url": "https://example.com",
              "signature": "text",
              "dsa": "text"
            }
          ],
          "images": [
            {
              "url": "https://example.com",
              "size_type": "xs",
              "width": "text",
              "height": "text"
            }
          ]
        },
        "updated_at": "2025-01-30T22:23:34.191Z",
        "updated_by": "text"
      },
      "reason_required": false,
      "cancel_by": {
        "label": "text",
        "timestamp": "2025-01-30T22:23:34.191Z",
        "duration": "text",
        "range": {
          "start": "2025-01-30T22:23:34.191Z",
          "end": "2025-01-30T22:23:34.191Z"
        },
        "days": "text",
        "schedule": {
          "frequency": "text",
          "holidays": [
            "2025-01-30T22:23:34.191Z"
          ],
          "times": [
            "2025-01-30T22:23:34.191Z"
          ]
        }
      },
      "cancellation_fee": {
        "percentage": {},
        "amount": {
          "currency": "text",
          "value": "text",
          "estimated_value": "text",
          "computed_value": "text",
          "listed_value": "text",
          "offered_value": "text",
          "minimum_value": "text",
          "maximum_value": "text"
        }
      },
      "xinput": {
        "id": "text",
        "head": {
          "descriptor": {
            "id": "text",
            "url": "https://example.com",
            "mime_type": "text/html",
            "submission_id": "123e4567-e89b-12d3-a456-426614174000"
          },
          "index": {
            "cur": 0,
            "max": 0,
            "min": 0
          },
          "headings": [
            "text"
          ]
        },
        "form": {
          "id": "text",
          "url": "https://example.com",
          "mime_type": "text/html",
          "submission_id": "123e4567-e89b-12d3-a456-426614174000"
        },
        "required": false
      },
      "external_ref": {
        "mimetype": "text",
        "url": "https://example.com",
        "signature": "text",
        "dsa": "text"
      }
    }
  ],
  "refund_terms": [
    {
      "fulfillment_state": {
        "name": "text",
        "code": "text"
      },
      "refund_eligible": false,
      "refund_within": {
        "label": "text",
        "timestamp": "2025-01-30T22:23:34.191Z",
        "duration": "text",
        "range": {
          "start": "2025-01-30T22:23:34.191Z",
          "end": "2025-01-30T22:23:34.191Z"
        },
        "days": "text",
        "schedule": {
          "frequency": "text",
          "holidays": [
            "2025-01-30T22:23:34.191Z"
          ],
          "times": [
            "2025-01-30T22:23:34.191Z"
          ]
        }
      },
      "refund_amount": {
        "currency": "text",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "listed_value": "text",
        "offered_value": "text",
        "minimum_value": "text",
        "maximum_value": "text"
      }
    }
  ],
  "replacement_terms": [
    {
      "fulfillment_state": {
        "name": "text",
        "code": "text"
      },
      "replace_within": {
        "label": "text",
        "timestamp": "2025-01-30T22:23:34.191Z",
        "duration": "text",
        "range": {
          "start": "2025-01-30T22:23:34.191Z",
          "end": "2025-01-30T22:23:34.191Z"
        },
        "days": "text",
        "schedule": {
          "frequency": "text",
          "holidays": [
            "2025-01-30T22:23:34.191Z"
          ],
          "times": [
            "2025-01-30T22:23:34.191Z"
          ]
        }
      },
      "external_ref": {
        "mimetype": "text",
        "url": "https://example.com",
        "signature": "text",
        "dsa": "text"
      }
    }
  ],
  "return_terms": [
    {
      "fulfillment_state": {
        "name": "text",
        "code": "text"
      },
      "return_eligible": false,
      "return_time": {
        "label": "text",
        "timestamp": "2025-01-30T22:23:34.191Z",
        "duration": "text",
        "range": {
          "start": "2025-01-30T22:23:34.191Z",
          "end": "2025-01-30T22:23:34.191Z"
        },
        "days": "text",
        "schedule": {
          "frequency": "text",
          "holidays": [
            "2025-01-30T22:23:34.191Z"
          ],
          "times": [
            "2025-01-30T22:23:34.191Z"
          ]
        }
      },
      "return_location": {
        "id": "text",
        "descriptor": {
          "name": "text",
          "code": "text",
          "short_desc": "text",
          "long_desc": "text",
          "additional_desc": {
            "url": "text",
            "content_type": "text/plain"
          },
          "media": [
            {
              "mimetype": "text",
              "url": "https://example.com",
              "signature": "text",
              "dsa": "text"
            }
          ],
          "images": [
            {
              "url": "https://example.com",
              "size_type": "xs",
              "width": "text",
              "height": "text"
            }
          ]
        },
        "map_url": "https://example.com",
        "gps": {},
        "address": {},
        "city": {
          "name": "text",
          "code": "text"
        },
        "district": "text",
        "state": {
          "name": "text",
          "code": "text"
        },
        "country": {
          "name": "text",
          "code": "text"
        },
        "area_code": "text",
        "circle": {
          "gps": "text",
          "radius": {
            "type": "CONSTANT",
            "value": "text",
            "estimated_value": "text",
            "computed_value": "text",
            "range": {
              "min": "text",
              "max": "text"
            },
            "unit": "text"
          }
        },
        "polygon": "text",
        "3dspace": "text",
        "rating": {}
      },
      "fulfillment_managed_by": "CONSUMER"
    }
  ],
  "xinput": {
    "id": "text",
    "head": {
      "descriptor": {
        "id": "text",
        "url": "https://example.com",
        "mime_type": "text/html",
        "submission_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "index": {
        "cur": 0,
        "max": 0,
        "min": 0
      },
      "headings": [
        "text"
      ]
    },
    "form": {
      "id": "text",
      "url": "https://example.com",
      "mime_type": "text/html",
      "submission_id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "required": false
  },
  "time": {
    "label": "text",
    "timestamp": "2025-01-30T22:23:34.191Z",
    "duration": "text",
    "range": {
      "start": "2025-01-30T22:23:34.191Z",
      "end": "2025-01-30T22:23:34.191Z"
    },
    "days": "text",
    "schedule": {
      "frequency": "text",
      "holidays": [
        "2025-01-30T22:23:34.191Z"
      ],
      "times": [
        "2025-01-30T22:23:34.191Z"
      ]
    }
  },
  "rateable": false,
  "rating": {},
  "matched": false,
  "related": false,
  "recommended": false,
  "ttl": "text",
  "tags": [
    {
      "display": true,
      "descriptor": {
        "name": "text",
        "code": "text",
        "short_desc": "text",
        "long_desc": "text",
        "additional_desc": {
          "url": "text",
          "content_type": "text/plain"
        },
        "media": [
          {
            "mimetype": "text",
            "url": "https://example.com",
            "signature": "text",
            "dsa": "text"
          }
        ],
        "images": [
          {
            "url": "https://example.com",
            "size_type": "xs",
            "width": "text",
            "height": "text"
          }
        ]
      },
      "list": [
        {
          "descriptor": {
            "name": "text",
            "code": "text",
            "short_desc": "text",
            "long_desc": "text",
            "additional_desc": {
              "url": "text",
              "content_type": "text/plain"
            },
            "media": [
              {
                "mimetype": "text",
                "url": "https://example.com",
                "signature": "text",
                "dsa": "text"
              }
            ],
            "images": [
              {
                "url": "https://example.com",
                "size_type": "xs",
                "width": "text",
                "height": "text"
              }
            ]
          },
          "value": "text",
          "display": false
        }
      ]
    }
  ]
}

Add Item to inventory

POSThttps://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/inventory/item/add

Body

application/json

idstring

ID of the item.

parent_item_idall of

ID of the item, this item is a variant of

parent_item_quantityall of

The number of units of the parent item this item is a multiple of

descriptorall of

Physical description of the item

creatorall of

The creator of this item

priceall of

The price of this item, if it has intrinsic value

quantityall of

The selling quantity of the item

category_idsarray of all of

Categories this item can be listed under

fulfillment_idsarray of all of

Modes through which this item can be fulfilled

location_idsarray of all of

Provider Locations this item is available in

payment_idsarray of all of

Payment modalities through which this item can be ordered

add_onsarray of object

cancellation_termsarray of object

Cancellation terms of this item

refund_termsarray of object

Refund terms of this item

replacement_termsarray of object

Terms that are applicable be met when this item is replaced

return_termsarray of object

Terms that are applicable when this item is returned

xinputall of

Additional input required from the customer to purchase / avail this item

timeall of

Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.

rateableboolean

Whether this item can be rated

ratingall of

The rating of the item

matchedboolean

Whether this item is an exact match of the request

relatedboolean

Whether this item is a related item to the exactly matched item

recommendedboolean

Whether this item is a recommended item to a response

ttlstring

Time to live in seconds for an instance of this schema

tagsarray of object

Response

default

Successful fetch of resources from the catalog

Body

application/json

idstring

ID of the item.

parent_item_idall of

ID of the item, this item is a variant of

parent_item_quantityall of

The number of units of the parent item this item is a multiple of

descriptorall of

Physical description of the item

creatorall of

The creator of this item

priceall of

The price of this item, if it has intrinsic value

quantityall of

The selling quantity of the item

category_idsarray of all of

Categories this item can be listed under

fulfillment_idsarray of all of

Modes through which this item can be fulfilled

location_idsarray of all of

Provider Locations this item is available in

payment_idsarray of all of

Payment modalities through which this item can be ordered

add_onsarray of object

cancellation_termsarray of object

Cancellation terms of this item

refund_termsarray of object

Refund terms of this item

replacement_termsarray of object

Terms that are applicable be met when this item is replaced

return_termsarray of object

Terms that are applicable when this item is returned

xinputall of

Additional input required from the customer to purchase / avail this item

timeall of

Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.

rateableboolean

Whether this item can be rated

ratingall of

The rating of the item

matchedboolean

Whether this item is an exact match of the request

relatedboolean

Whether this item is a related item to the exactly matched item

recommendedboolean

Whether this item is a recommended item to a response

ttlstring

Time to live in seconds for an instance of this schema

tagsarray of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/inventory/item/add', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

default

{
  "id": "text",
  "parent_item_id": {},
  "parent_item_quantity": {
    "allocated": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "available": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "maximum": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "minimum": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "selected": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "unitized": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    }
  },
  "descriptor": {
    "name": "text",
    "code": "text",
    "short_desc": "text",
    "long_desc": "text",
    "additional_desc": {
      "url": "text",
      "content_type": "text/plain"
    },
    "media": [
      {
        "mimetype": "text",
        "url": "https://example.com",
        "signature": "text",
        "dsa": "text"
      }
    ],
    "images": [
      {
        "url": "https://example.com",
        "size_type": "xs",
        "width": "text",
        "height": "text"
      }
    ]
  },
  "creator": {
    "descriptor": {
      "name": "text",
      "code": "text",
      "short_desc": "text",
      "long_desc": "text",
      "additional_desc": {
        "url": "text",
        "content_type": "text/plain"
      },
      "media": [
        {
          "mimetype": "text",
          "url": "https://example.com",
          "signature": "text",
          "dsa": "text"
        }
      ],
      "images": [
        {
          "url": "https://example.com",
          "size_type": "xs",
          "width": "text",
          "height": "text"
        }
      ]
    },
    "address": {},
    "state": {
      "name": "text",
      "code": "text"
    },
    "city": {
      "name": "text",
      "code": "text"
    },
    "contact": {
      "phone": "text",
      "email": "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": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "available": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "maximum": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "minimum": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "selected": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "unitized": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    }
  },
  "category_ids": [
    {}
  ],
  "fulfillment_ids": [
    {}
  ],
  "location_ids": [
    {}
  ],
  "payment_ids": [
    {}
  ],
  "add_ons": [
    {
      "id": "text",
      "descriptor": {
        "name": "text",
        "code": "text",
        "short_desc": "text",
        "long_desc": "text",
        "additional_desc": {
          "url": "text",
          "content_type": "text/plain"
        },
        "media": [
          {
            "mimetype": "text",
            "url": "https://example.com",
            "signature": "text",
            "dsa": "text"
          }
        ],
        "images": [
          {
            "url": "https://example.com",
            "size_type": "xs",
            "width": "text",
            "height": "text"
          }
        ]
      },
      "price": {
        "currency": "text",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "listed_value": "text",
        "offered_value": "text",
        "minimum_value": "text",
        "maximum_value": "text"
      }
    }
  ],
  "cancellation_terms": [
    {
      "fulfillment_state": {
        "descriptor": {
          "name": "text",
          "code": "text",
          "short_desc": "text",
          "long_desc": "text",
          "additional_desc": {
            "url": "text",
            "content_type": "text/plain"
          },
          "media": [
            {
              "mimetype": "text",
              "url": "https://example.com",
              "signature": "text",
              "dsa": "text"
            }
          ],
          "images": [
            {
              "url": "https://example.com",
              "size_type": "xs",
              "width": "text",
              "height": "text"
            }
          ]
        },
        "updated_at": "2025-01-30T22:23:34.191Z",
        "updated_by": "text"
      },
      "reason_required": false,
      "cancel_by": {
        "label": "text",
        "timestamp": "2025-01-30T22:23:34.191Z",
        "duration": "text",
        "range": {
          "start": "2025-01-30T22:23:34.191Z",
          "end": "2025-01-30T22:23:34.191Z"
        },
        "days": "text",
        "schedule": {
          "frequency": "text",
          "holidays": [
            "2025-01-30T22:23:34.191Z"
          ],
          "times": [
            "2025-01-30T22:23:34.191Z"
          ]
        }
      },
      "cancellation_fee": {
        "percentage": {},
        "amount": {
          "currency": "text",
          "value": "text",
          "estimated_value": "text",
          "computed_value": "text",
          "listed_value": "text",
          "offered_value": "text",
          "minimum_value": "text",
          "maximum_value": "text"
        }
      },
      "xinput": {
        "id": "text",
        "head": {
          "descriptor": {
            "id": "text",
            "url": "https://example.com",
            "mime_type": "text/html",
            "submission_id": "123e4567-e89b-12d3-a456-426614174000"
          },
          "index": {
            "cur": 0,
            "max": 0,
            "min": 0
          },
          "headings": [
            "text"
          ]
        },
        "form": {
          "id": "text",
          "url": "https://example.com",
          "mime_type": "text/html",
          "submission_id": "123e4567-e89b-12d3-a456-426614174000"
        },
        "required": false
      },
      "external_ref": {
        "mimetype": "text",
        "url": "https://example.com",
        "signature": "text",
        "dsa": "text"
      }
    }
  ],
  "refund_terms": [
    {
      "fulfillment_state": {
        "name": "text",
        "code": "text"
      },
      "refund_eligible": false,
      "refund_within": {
        "label": "text",
        "timestamp": "2025-01-30T22:23:34.191Z",
        "duration": "text",
        "range": {
          "start": "2025-01-30T22:23:34.191Z",
          "end": "2025-01-30T22:23:34.191Z"
        },
        "days": "text",
        "schedule": {
          "frequency": "text",
          "holidays": [
            "2025-01-30T22:23:34.191Z"
          ],
          "times": [
            "2025-01-30T22:23:34.191Z"
          ]
        }
      },
      "refund_amount": {
        "currency": "text",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "listed_value": "text",
        "offered_value": "text",
        "minimum_value": "text",
        "maximum_value": "text"
      }
    }
  ],
  "replacement_terms": [
    {
      "fulfillment_state": {
        "name": "text",
        "code": "text"
      },
      "replace_within": {
        "label": "text",
        "timestamp": "2025-01-30T22:23:34.191Z",
        "duration": "text",
        "range": {
          "start": "2025-01-30T22:23:34.191Z",
          "end": "2025-01-30T22:23:34.191Z"
        },
        "days": "text",
        "schedule": {
          "frequency": "text",
          "holidays": [
            "2025-01-30T22:23:34.191Z"
          ],
          "times": [
            "2025-01-30T22:23:34.191Z"
          ]
        }
      },
      "external_ref": {
        "mimetype": "text",
        "url": "https://example.com",
        "signature": "text",
        "dsa": "text"
      }
    }
  ],
  "return_terms": [
    {
      "fulfillment_state": {
        "name": "text",
        "code": "text"
      },
      "return_eligible": false,
      "return_time": {
        "label": "text",
        "timestamp": "2025-01-30T22:23:34.191Z",
        "duration": "text",
        "range": {
          "start": "2025-01-30T22:23:34.191Z",
          "end": "2025-01-30T22:23:34.191Z"
        },
        "days": "text",
        "schedule": {
          "frequency": "text",
          "holidays": [
            "2025-01-30T22:23:34.191Z"
          ],
          "times": [
            "2025-01-30T22:23:34.191Z"
          ]
        }
      },
      "return_location": {
        "id": "text",
        "descriptor": {
          "name": "text",
          "code": "text",
          "short_desc": "text",
          "long_desc": "text",
          "additional_desc": {
            "url": "text",
            "content_type": "text/plain"
          },
          "media": [
            {
              "mimetype": "text",
              "url": "https://example.com",
              "signature": "text",
              "dsa": "text"
            }
          ],
          "images": [
            {
              "url": "https://example.com",
              "size_type": "xs",
              "width": "text",
              "height": "text"
            }
          ]
        },
        "map_url": "https://example.com",
        "gps": {},
        "address": {},
        "city": {
          "name": "text",
          "code": "text"
        },
        "district": "text",
        "state": {
          "name": "text",
          "code": "text"
        },
        "country": {
          "name": "text",
          "code": "text"
        },
        "area_code": "text",
        "circle": {
          "gps": "text",
          "radius": {
            "type": "CONSTANT",
            "value": "text",
            "estimated_value": "text",
            "computed_value": "text",
            "range": {
              "min": "text",
              "max": "text"
            },
            "unit": "text"
          }
        },
        "polygon": "text",
        "3dspace": "text",
        "rating": {}
      },
      "fulfillment_managed_by": "CONSUMER"
    }
  ],
  "xinput": {
    "id": "text",
    "head": {
      "descriptor": {
        "id": "text",
        "url": "https://example.com",
        "mime_type": "text/html",
        "submission_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "index": {
        "cur": 0,
        "max": 0,
        "min": 0
      },
      "headings": [
        "text"
      ]
    },
    "form": {
      "id": "text",
      "url": "https://example.com",
      "mime_type": "text/html",
      "submission_id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "required": false
  },
  "time": {
    "label": "text",
    "timestamp": "2025-01-30T22:23:34.191Z",
    "duration": "text",
    "range": {
      "start": "2025-01-30T22:23:34.191Z",
      "end": "2025-01-30T22:23:34.191Z"
    },
    "days": "text",
    "schedule": {
      "frequency": "text",
      "holidays": [
        "2025-01-30T22:23:34.191Z"
      ],
      "times": [
        "2025-01-30T22:23:34.191Z"
      ]
    }
  },
  "rateable": false,
  "rating": {},
  "matched": false,
  "related": false,
  "recommended": false,
  "ttl": "text",
  "tags": [
    {
      "display": true,
      "descriptor": {
        "name": "text",
        "code": "text",
        "short_desc": "text",
        "long_desc": "text",
        "additional_desc": {
          "url": "text",
          "content_type": "text/plain"
        },
        "media": [
          {
            "mimetype": "text",
            "url": "https://example.com",
            "signature": "text",
            "dsa": "text"
          }
        ],
        "images": [
          {
            "url": "https://example.com",
            "size_type": "xs",
            "width": "text",
            "height": "text"
          }
        ]
      },
      "list": [
        {
          "descriptor": {
            "name": "text",
            "code": "text",
            "short_desc": "text",
            "long_desc": "text",
            "additional_desc": {
              "url": "text",
              "content_type": "text/plain"
            },
            "media": [
              {
                "mimetype": "text",
                "url": "https://example.com",
                "signature": "text",
                "dsa": "text"
              }
            ],
            "images": [
              {
                "url": "https://example.com",
                "size_type": "xs",
                "width": "text",
                "height": "text"
              }
            ]
          },
          "value": "text",
          "display": false
        }
      ]
    }
  ]
}

Remove Item from inventory

POSThttps://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/inventory/item/remove

Body

application/json

idstring

ID of the item.

parent_item_idall of

ID of the item, this item is a variant of

parent_item_quantityall of

The number of units of the parent item this item is a multiple of

descriptorall of

Physical description of the item

creatorall of

The creator of this item

priceall of

The price of this item, if it has intrinsic value

quantityall of

The selling quantity of the item

category_idsarray of all of

Categories this item can be listed under

fulfillment_idsarray of all of

Modes through which this item can be fulfilled

location_idsarray of all of

Provider Locations this item is available in

payment_idsarray of all of

Payment modalities through which this item can be ordered

add_onsarray of object

cancellation_termsarray of object

Cancellation terms of this item

refund_termsarray of object

Refund terms of this item

replacement_termsarray of object

Terms that are applicable be met when this item is replaced

return_termsarray of object

Terms that are applicable when this item is returned

xinputall of

Additional input required from the customer to purchase / avail this item

timeall of

Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.

rateableboolean

Whether this item can be rated

ratingall of

The rating of the item

matchedboolean

Whether this item is an exact match of the request

relatedboolean

Whether this item is a related item to the exactly matched item

recommendedboolean

Whether this item is a recommended item to a response

ttlstring

Time to live in seconds for an instance of this schema

tagsarray of object

Response

default

Successful fetch of resources from the catalog

Body

application/json

idstring

ID of the item.

parent_item_idall of

ID of the item, this item is a variant of

parent_item_quantityall of

The number of units of the parent item this item is a multiple of

descriptorall of

Physical description of the item

creatorall of

The creator of this item

priceall of

The price of this item, if it has intrinsic value

quantityall of

The selling quantity of the item

category_idsarray of all of

Categories this item can be listed under

fulfillment_idsarray of all of

Modes through which this item can be fulfilled

location_idsarray of all of

Provider Locations this item is available in

payment_idsarray of all of

Payment modalities through which this item can be ordered

add_onsarray of object

cancellation_termsarray of object

Cancellation terms of this item

refund_termsarray of object

Refund terms of this item

replacement_termsarray of object

Terms that are applicable be met when this item is replaced

return_termsarray of object

Terms that are applicable when this item is returned

xinputall of

Additional input required from the customer to purchase / avail this item

timeall of

Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.

rateableboolean

Whether this item can be rated

ratingall of

The rating of the item

matchedboolean

Whether this item is an exact match of the request

relatedboolean

Whether this item is a related item to the exactly matched item

recommendedboolean

Whether this item is a recommended item to a response

ttlstring

Time to live in seconds for an instance of this schema

tagsarray of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/inventory/item/remove', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

default

{
  "id": "text",
  "parent_item_id": {},
  "parent_item_quantity": {
    "allocated": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "available": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "maximum": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "minimum": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "selected": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "unitized": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    }
  },
  "descriptor": {
    "name": "text",
    "code": "text",
    "short_desc": "text",
    "long_desc": "text",
    "additional_desc": {
      "url": "text",
      "content_type": "text/plain"
    },
    "media": [
      {
        "mimetype": "text",
        "url": "https://example.com",
        "signature": "text",
        "dsa": "text"
      }
    ],
    "images": [
      {
        "url": "https://example.com",
        "size_type": "xs",
        "width": "text",
        "height": "text"
      }
    ]
  },
  "creator": {
    "descriptor": {
      "name": "text",
      "code": "text",
      "short_desc": "text",
      "long_desc": "text",
      "additional_desc": {
        "url": "text",
        "content_type": "text/plain"
      },
      "media": [
        {
          "mimetype": "text",
          "url": "https://example.com",
          "signature": "text",
          "dsa": "text"
        }
      ],
      "images": [
        {
          "url": "https://example.com",
          "size_type": "xs",
          "width": "text",
          "height": "text"
        }
      ]
    },
    "address": {},
    "state": {
      "name": "text",
      "code": "text"
    },
    "city": {
      "name": "text",
      "code": "text"
    },
    "contact": {
      "phone": "text",
      "email": "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": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "available": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "maximum": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "minimum": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "selected": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "unitized": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    }
  },
  "category_ids": [
    {}
  ],
  "fulfillment_ids": [
    {}
  ],
  "location_ids": [
    {}
  ],
  "payment_ids": [
    {}
  ],
  "add_ons": [
    {
      "id": "text",
      "descriptor": {
        "name": "text",
        "code": "text",
        "short_desc": "text",
        "long_desc": "text",
        "additional_desc": {
          "url": "text",
          "content_type": "text/plain"
        },
        "media": [
          {
            "mimetype": "text",
            "url": "https://example.com",
            "signature": "text",
            "dsa": "text"
          }
        ],
        "images": [
          {
            "url": "https://example.com",
            "size_type": "xs",
            "width": "text",
            "height": "text"
          }
        ]
      },
      "price": {
        "currency": "text",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "listed_value": "text",
        "offered_value": "text",
        "minimum_value": "text",
        "maximum_value": "text"
      }
    }
  ],
  "cancellation_terms": [
    {
      "fulfillment_state": {
        "descriptor": {
          "name": "text",
          "code": "text",
          "short_desc": "text",
          "long_desc": "text",
          "additional_desc": {
            "url": "text",
            "content_type": "text/plain"
          },
          "media": [
            {
              "mimetype": "text",
              "url": "https://example.com",
              "signature": "text",
              "dsa": "text"
            }
          ],
          "images": [
            {
              "url": "https://example.com",
              "size_type": "xs",
              "width": "text",
              "height": "text"
            }
          ]
        },
        "updated_at": "2025-01-30T22:23:34.191Z",
        "updated_by": "text"
      },
      "reason_required": false,
      "cancel_by": {
        "label": "text",
        "timestamp": "2025-01-30T22:23:34.191Z",
        "duration": "text",
        "range": {
          "start": "2025-01-30T22:23:34.191Z",
          "end": "2025-01-30T22:23:34.191Z"
        },
        "days": "text",
        "schedule": {
          "frequency": "text",
          "holidays": [
            "2025-01-30T22:23:34.191Z"
          ],
          "times": [
            "2025-01-30T22:23:34.191Z"
          ]
        }
      },
      "cancellation_fee": {
        "percentage": {},
        "amount": {
          "currency": "text",
          "value": "text",
          "estimated_value": "text",
          "computed_value": "text",
          "listed_value": "text",
          "offered_value": "text",
          "minimum_value": "text",
          "maximum_value": "text"
        }
      },
      "xinput": {
        "id": "text",
        "head": {
          "descriptor": {
            "id": "text",
            "url": "https://example.com",
            "mime_type": "text/html",
            "submission_id": "123e4567-e89b-12d3-a456-426614174000"
          },
          "index": {
            "cur": 0,
            "max": 0,
            "min": 0
          },
          "headings": [
            "text"
          ]
        },
        "form": {
          "id": "text",
          "url": "https://example.com",
          "mime_type": "text/html",
          "submission_id": "123e4567-e89b-12d3-a456-426614174000"
        },
        "required": false
      },
      "external_ref": {
        "mimetype": "text",
        "url": "https://example.com",
        "signature": "text",
        "dsa": "text"
      }
    }
  ],
  "refund_terms": [
    {
      "fulfillment_state": {
        "name": "text",
        "code": "text"
      },
      "refund_eligible": false,
      "refund_within": {
        "label": "text",
        "timestamp": "2025-01-30T22:23:34.191Z",
        "duration": "text",
        "range": {
          "start": "2025-01-30T22:23:34.191Z",
          "end": "2025-01-30T22:23:34.191Z"
        },
        "days": "text",
        "schedule": {
          "frequency": "text",
          "holidays": [
            "2025-01-30T22:23:34.191Z"
          ],
          "times": [
            "2025-01-30T22:23:34.191Z"
          ]
        }
      },
      "refund_amount": {
        "currency": "text",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "listed_value": "text",
        "offered_value": "text",
        "minimum_value": "text",
        "maximum_value": "text"
      }
    }
  ],
  "replacement_terms": [
    {
      "fulfillment_state": {
        "name": "text",
        "code": "text"
      },
      "replace_within": {
        "label": "text",
        "timestamp": "2025-01-30T22:23:34.191Z",
        "duration": "text",
        "range": {
          "start": "2025-01-30T22:23:34.191Z",
          "end": "2025-01-30T22:23:34.191Z"
        },
        "days": "text",
        "schedule": {
          "frequency": "text",
          "holidays": [
            "2025-01-30T22:23:34.191Z"
          ],
          "times": [
            "2025-01-30T22:23:34.191Z"
          ]
        }
      },
      "external_ref": {
        "mimetype": "text",
        "url": "https://example.com",
        "signature": "text",
        "dsa": "text"
      }
    }
  ],
  "return_terms": [
    {
      "fulfillment_state": {
        "name": "text",
        "code": "text"
      },
      "return_eligible": false,
      "return_time": {
        "label": "text",
        "timestamp": "2025-01-30T22:23:34.191Z",
        "duration": "text",
        "range": {
          "start": "2025-01-30T22:23:34.191Z",
          "end": "2025-01-30T22:23:34.191Z"
        },
        "days": "text",
        "schedule": {
          "frequency": "text",
          "holidays": [
            "2025-01-30T22:23:34.191Z"
          ],
          "times": [
            "2025-01-30T22:23:34.191Z"
          ]
        }
      },
      "return_location": {
        "id": "text",
        "descriptor": {
          "name": "text",
          "code": "text",
          "short_desc": "text",
          "long_desc": "text",
          "additional_desc": {
            "url": "text",
            "content_type": "text/plain"
          },
          "media": [
            {
              "mimetype": "text",
              "url": "https://example.com",
              "signature": "text",
              "dsa": "text"
            }
          ],
          "images": [
            {
              "url": "https://example.com",
              "size_type": "xs",
              "width": "text",
              "height": "text"
            }
          ]
        },
        "map_url": "https://example.com",
        "gps": {},
        "address": {},
        "city": {
          "name": "text",
          "code": "text"
        },
        "district": "text",
        "state": {
          "name": "text",
          "code": "text"
        },
        "country": {
          "name": "text",
          "code": "text"
        },
        "area_code": "text",
        "circle": {
          "gps": "text",
          "radius": {
            "type": "CONSTANT",
            "value": "text",
            "estimated_value": "text",
            "computed_value": "text",
            "range": {
              "min": "text",
              "max": "text"
            },
            "unit": "text"
          }
        },
        "polygon": "text",
        "3dspace": "text",
        "rating": {}
      },
      "fulfillment_managed_by": "CONSUMER"
    }
  ],
  "xinput": {
    "id": "text",
    "head": {
      "descriptor": {
        "id": "text",
        "url": "https://example.com",
        "mime_type": "text/html",
        "submission_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "index": {
        "cur": 0,
        "max": 0,
        "min": 0
      },
      "headings": [
        "text"
      ]
    },
    "form": {
      "id": "text",
      "url": "https://example.com",
      "mime_type": "text/html",
      "submission_id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "required": false
  },
  "time": {
    "label": "text",
    "timestamp": "2025-01-30T22:23:34.191Z",
    "duration": "text",
    "range": {
      "start": "2025-01-30T22:23:34.191Z",
      "end": "2025-01-30T22:23:34.191Z"
    },
    "days": "text",
    "schedule": {
      "frequency": "text",
      "holidays": [
        "2025-01-30T22:23:34.191Z"
      ],
      "times": [
        "2025-01-30T22:23:34.191Z"
      ]
    }
  },
  "rateable": false,
  "rating": {},
  "matched": false,
  "related": false,
  "recommended": false,
  "ttl": "text",
  "tags": [
    {
      "display": true,
      "descriptor": {
        "name": "text",
        "code": "text",
        "short_desc": "text",
        "long_desc": "text",
        "additional_desc": {
          "url": "text",
          "content_type": "text/plain"
        },
        "media": [
          {
            "mimetype": "text",
            "url": "https://example.com",
            "signature": "text",
            "dsa": "text"
          }
        ],
        "images": [
          {
            "url": "https://example.com",
            "size_type": "xs",
            "width": "text",
            "height": "text"
          }
        ]
      },
      "list": [
        {
          "descriptor": {
            "name": "text",
            "code": "text",
            "short_desc": "text",
            "long_desc": "text",
            "additional_desc": {
              "url": "text",
              "content_type": "text/plain"
            },
            "media": [
              {
                "mimetype": "text",
                "url": "https://example.com",
                "signature": "text",
                "dsa": "text"
              }
            ],
            "images": [
              {
                "url": "https://example.com",
                "size_type": "xs",
                "width": "text",
                "height": "text"
              }
            ]
          },
          "value": "text",
          "display": false
        }
      ]
    }
  ]
}

Block Item in inventory

POSThttps://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/inventory/item/block

Body

application/json

idstring

ID of the item.

parent_item_idall of

ID of the item, this item is a variant of

parent_item_quantityall of

The number of units of the parent item this item is a multiple of

descriptorall of

Physical description of the item

creatorall of

The creator of this item

priceall of

The price of this item, if it has intrinsic value

quantityall of

The selling quantity of the item

category_idsarray of all of

Categories this item can be listed under

fulfillment_idsarray of all of

Modes through which this item can be fulfilled

location_idsarray of all of

Provider Locations this item is available in

payment_idsarray of all of

Payment modalities through which this item can be ordered

add_onsarray of object

cancellation_termsarray of object

Cancellation terms of this item

refund_termsarray of object

Refund terms of this item

replacement_termsarray of object

Terms that are applicable be met when this item is replaced

return_termsarray of object

Terms that are applicable when this item is returned

xinputall of

Additional input required from the customer to purchase / avail this item

timeall of

Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.

rateableboolean

Whether this item can be rated

ratingall of

The rating of the item

matchedboolean

Whether this item is an exact match of the request

relatedboolean

Whether this item is a related item to the exactly matched item

recommendedboolean

Whether this item is a recommended item to a response

ttlstring

Time to live in seconds for an instance of this schema

tagsarray of object

Response

default

Successful fetch of resources from the catalog

Body

application/json

idstring

ID of the item.

parent_item_idall of

ID of the item, this item is a variant of

parent_item_quantityall of

The number of units of the parent item this item is a multiple of

descriptorall of

Physical description of the item

creatorall of

The creator of this item

priceall of

The price of this item, if it has intrinsic value

quantityall of

The selling quantity of the item

category_idsarray of all of

Categories this item can be listed under

fulfillment_idsarray of all of

Modes through which this item can be fulfilled

location_idsarray of all of

Provider Locations this item is available in

payment_idsarray of all of

Payment modalities through which this item can be ordered

add_onsarray of object

cancellation_termsarray of object

Cancellation terms of this item

refund_termsarray of object

Refund terms of this item

replacement_termsarray of object

Terms that are applicable be met when this item is replaced

return_termsarray of object

Terms that are applicable when this item is returned

xinputall of

Additional input required from the customer to purchase / avail this item

timeall of

Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.

rateableboolean

Whether this item can be rated

ratingall of

The rating of the item

matchedboolean

Whether this item is an exact match of the request

relatedboolean

Whether this item is a related item to the exactly matched item

recommendedboolean

Whether this item is a recommended item to a response

ttlstring

Time to live in seconds for an instance of this schema

tagsarray of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/inventory/item/block', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

default

{
  "id": "text",
  "parent_item_id": {},
  "parent_item_quantity": {
    "allocated": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "available": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "maximum": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "minimum": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "selected": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "unitized": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    }
  },
  "descriptor": {
    "name": "text",
    "code": "text",
    "short_desc": "text",
    "long_desc": "text",
    "additional_desc": {
      "url": "text",
      "content_type": "text/plain"
    },
    "media": [
      {
        "mimetype": "text",
        "url": "https://example.com",
        "signature": "text",
        "dsa": "text"
      }
    ],
    "images": [
      {
        "url": "https://example.com",
        "size_type": "xs",
        "width": "text",
        "height": "text"
      }
    ]
  },
  "creator": {
    "descriptor": {
      "name": "text",
      "code": "text",
      "short_desc": "text",
      "long_desc": "text",
      "additional_desc": {
        "url": "text",
        "content_type": "text/plain"
      },
      "media": [
        {
          "mimetype": "text",
          "url": "https://example.com",
          "signature": "text",
          "dsa": "text"
        }
      ],
      "images": [
        {
          "url": "https://example.com",
          "size_type": "xs",
          "width": "text",
          "height": "text"
        }
      ]
    },
    "address": {},
    "state": {
      "name": "text",
      "code": "text"
    },
    "city": {
      "name": "text",
      "code": "text"
    },
    "contact": {
      "phone": "text",
      "email": "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": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "available": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "maximum": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "minimum": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "selected": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "unitized": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    }
  },
  "category_ids": [
    {}
  ],
  "fulfillment_ids": [
    {}
  ],
  "location_ids": [
    {}
  ],
  "payment_ids": [
    {}
  ],
  "add_ons": [
    {
      "id": "text",
      "descriptor": {
        "name": "text",
        "code": "text",
        "short_desc": "text",
        "long_desc": "text",
        "additional_desc": {
          "url": "text",
          "content_type": "text/plain"
        },
        "media": [
          {
            "mimetype": "text",
            "url": "https://example.com",
            "signature": "text",
            "dsa": "text"
          }
        ],
        "images": [
          {
            "url": "https://example.com",
            "size_type": "xs",
            "width": "text",
            "height": "text"
          }
        ]
      },
      "price": {
        "currency": "text",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "listed_value": "text",
        "offered_value": "text",
        "minimum_value": "text",
        "maximum_value": "text"
      }
    }
  ],
  "cancellation_terms": [
    {
      "fulfillment_state": {
        "descriptor": {
          "name": "text",
          "code": "text",
          "short_desc": "text",
          "long_desc": "text",
          "additional_desc": {
            "url": "text",
            "content_type": "text/plain"
          },
          "media": [
            {
              "mimetype": "text",
              "url": "https://example.com",
              "signature": "text",
              "dsa": "text"
            }
          ],
          "images": [
            {
              "url": "https://example.com",
              "size_type": "xs",
              "width": "text",
              "height": "text"
            }
          ]
        },
        "updated_at": "2025-01-30T22:23:34.191Z",
        "updated_by": "text"
      },
      "reason_required": false,
      "cancel_by": {
        "label": "text",
        "timestamp": "2025-01-30T22:23:34.191Z",
        "duration": "text",
        "range": {
          "start": "2025-01-30T22:23:34.191Z",
          "end": "2025-01-30T22:23:34.191Z"
        },
        "days": "text",
        "schedule": {
          "frequency": "text",
          "holidays": [
            "2025-01-30T22:23:34.191Z"
          ],
          "times": [
            "2025-01-30T22:23:34.191Z"
          ]
        }
      },
      "cancellation_fee": {
        "percentage": {},
        "amount": {
          "currency": "text",
          "value": "text",
          "estimated_value": "text",
          "computed_value": "text",
          "listed_value": "text",
          "offered_value": "text",
          "minimum_value": "text",
          "maximum_value": "text"
        }
      },
      "xinput": {
        "id": "text",
        "head": {
          "descriptor": {
            "id": "text",
            "url": "https://example.com",
            "mime_type": "text/html",
            "submission_id": "123e4567-e89b-12d3-a456-426614174000"
          },
          "index": {
            "cur": 0,
            "max": 0,
            "min": 0
          },
          "headings": [
            "text"
          ]
        },
        "form": {
          "id": "text",
          "url": "https://example.com",
          "mime_type": "text/html",
          "submission_id": "123e4567-e89b-12d3-a456-426614174000"
        },
        "required": false
      },
      "external_ref": {
        "mimetype": "text",
        "url": "https://example.com",
        "signature": "text",
        "dsa": "text"
      }
    }
  ],
  "refund_terms": [
    {
      "fulfillment_state": {
        "name": "text",
        "code": "text"
      },
      "refund_eligible": false,
      "refund_within": {
        "label": "text",
        "timestamp": "2025-01-30T22:23:34.191Z",
        "duration": "text",
        "range": {
          "start": "2025-01-30T22:23:34.191Z",
          "end": "2025-01-30T22:23:34.191Z"
        },
        "days": "text",
        "schedule": {
          "frequency": "text",
          "holidays": [
            "2025-01-30T22:23:34.191Z"
          ],
          "times": [
            "2025-01-30T22:23:34.191Z"
          ]
        }
      },
      "refund_amount": {
        "currency": "text",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "listed_value": "text",
        "offered_value": "text",
        "minimum_value": "text",
        "maximum_value": "text"
      }
    }
  ],
  "replacement_terms": [
    {
      "fulfillment_state": {
        "name": "text",
        "code": "text"
      },
      "replace_within": {
        "label": "text",
        "timestamp": "2025-01-30T22:23:34.191Z",
        "duration": "text",
        "range": {
          "start": "2025-01-30T22:23:34.191Z",
          "end": "2025-01-30T22:23:34.191Z"
        },
        "days": "text",
        "schedule": {
          "frequency": "text",
          "holidays": [
            "2025-01-30T22:23:34.191Z"
          ],
          "times": [
            "2025-01-30T22:23:34.191Z"
          ]
        }
      },
      "external_ref": {
        "mimetype": "text",
        "url": "https://example.com",
        "signature": "text",
        "dsa": "text"
      }
    }
  ],
  "return_terms": [
    {
      "fulfillment_state": {
        "name": "text",
        "code": "text"
      },
      "return_eligible": false,
      "return_time": {
        "label": "text",
        "timestamp": "2025-01-30T22:23:34.191Z",
        "duration": "text",
        "range": {
          "start": "2025-01-30T22:23:34.191Z",
          "end": "2025-01-30T22:23:34.191Z"
        },
        "days": "text",
        "schedule": {
          "frequency": "text",
          "holidays": [
            "2025-01-30T22:23:34.191Z"
          ],
          "times": [
            "2025-01-30T22:23:34.191Z"
          ]
        }
      },
      "return_location": {
        "id": "text",
        "descriptor": {
          "name": "text",
          "code": "text",
          "short_desc": "text",
          "long_desc": "text",
          "additional_desc": {
            "url": "text",
            "content_type": "text/plain"
          },
          "media": [
            {
              "mimetype": "text",
              "url": "https://example.com",
              "signature": "text",
              "dsa": "text"
            }
          ],
          "images": [
            {
              "url": "https://example.com",
              "size_type": "xs",
              "width": "text",
              "height": "text"
            }
          ]
        },
        "map_url": "https://example.com",
        "gps": {},
        "address": {},
        "city": {
          "name": "text",
          "code": "text"
        },
        "district": "text",
        "state": {
          "name": "text",
          "code": "text"
        },
        "country": {
          "name": "text",
          "code": "text"
        },
        "area_code": "text",
        "circle": {
          "gps": "text",
          "radius": {
            "type": "CONSTANT",
            "value": "text",
            "estimated_value": "text",
            "computed_value": "text",
            "range": {
              "min": "text",
              "max": "text"
            },
            "unit": "text"
          }
        },
        "polygon": "text",
        "3dspace": "text",
        "rating": {}
      },
      "fulfillment_managed_by": "CONSUMER"
    }
  ],
  "xinput": {
    "id": "text",
    "head": {
      "descriptor": {
        "id": "text",
        "url": "https://example.com",
        "mime_type": "text/html",
        "submission_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "index": {
        "cur": 0,
        "max": 0,
        "min": 0
      },
      "headings": [
        "text"
      ]
    },
    "form": {
      "id": "text",
      "url": "https://example.com",
      "mime_type": "text/html",
      "submission_id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "required": false
  },
  "time": {
    "label": "text",
    "timestamp": "2025-01-30T22:23:34.191Z",
    "duration": "text",
    "range": {
      "start": "2025-01-30T22:23:34.191Z",
      "end": "2025-01-30T22:23:34.191Z"
    },
    "days": "text",
    "schedule": {
      "frequency": "text",
      "holidays": [
        "2025-01-30T22:23:34.191Z"
      ],
      "times": [
        "2025-01-30T22:23:34.191Z"
      ]
    }
  },
  "rateable": false,
  "rating": {},
  "matched": false,
  "related": false,
  "recommended": false,
  "ttl": "text",
  "tags": [
    {
      "display": true,
      "descriptor": {
        "name": "text",
        "code": "text",
        "short_desc": "text",
        "long_desc": "text",
        "additional_desc": {
          "url": "text",
          "content_type": "text/plain"
        },
        "media": [
          {
            "mimetype": "text",
            "url": "https://example.com",
            "signature": "text",
            "dsa": "text"
          }
        ],
        "images": [
          {
            "url": "https://example.com",
            "size_type": "xs",
            "width": "text",
            "height": "text"
          }
        ]
      },
      "list": [
        {
          "descriptor": {
            "name": "text",
            "code": "text",
            "short_desc": "text",
            "long_desc": "text",
            "additional_desc": {
              "url": "text",
              "content_type": "text/plain"
            },
            "media": [
              {
                "mimetype": "text",
                "url": "https://example.com",
                "signature": "text",
                "dsa": "text"
              }
            ],
            "images": [
              {
                "url": "https://example.com",
                "size_type": "xs",
                "width": "text",
                "height": "text"
              }
            ]
          },
          "value": "text",
          "display": false
        }
      ]
    }
  ]
}

Unblock addOn in inventory

POSThttps://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/inventory/addOn/unblock

Body

application/json

idstring

ID of the item.

parent_item_idall of

ID of the item, this item is a variant of

parent_item_quantityall of

The number of units of the parent item this item is a multiple of

descriptorall of

Physical description of the item

creatorall of

The creator of this item

priceall of

The price of this item, if it has intrinsic value

quantityall of

The selling quantity of the item

category_idsarray of all of

Categories this item can be listed under

fulfillment_idsarray of all of

Modes through which this item can be fulfilled

location_idsarray of all of

Provider Locations this item is available in

payment_idsarray of all of

Payment modalities through which this item can be ordered

add_onsarray of object

cancellation_termsarray of object

Cancellation terms of this item

refund_termsarray of object

Refund terms of this item

replacement_termsarray of object

Terms that are applicable be met when this item is replaced

return_termsarray of object

Terms that are applicable when this item is returned

xinputall of

Additional input required from the customer to purchase / avail this item

timeall of

Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.

rateableboolean

Whether this item can be rated

ratingall of

The rating of the item

matchedboolean

Whether this item is an exact match of the request

relatedboolean

Whether this item is a related item to the exactly matched item

recommendedboolean

Whether this item is a recommended item to a response

ttlstring

Time to live in seconds for an instance of this schema

tagsarray of object

Response

default

Successful fetch of resources from the catalog

Body

application/json

idstring

ID of the item.

parent_item_idall of

ID of the item, this item is a variant of

parent_item_quantityall of

The number of units of the parent item this item is a multiple of

descriptorall of

Physical description of the item

creatorall of

The creator of this item

priceall of

The price of this item, if it has intrinsic value

quantityall of

The selling quantity of the item

category_idsarray of all of

Categories this item can be listed under

fulfillment_idsarray of all of

Modes through which this item can be fulfilled

location_idsarray of all of

Provider Locations this item is available in

payment_idsarray of all of

Payment modalities through which this item can be ordered

add_onsarray of object

cancellation_termsarray of object

Cancellation terms of this item

refund_termsarray of object

Refund terms of this item

replacement_termsarray of object

Terms that are applicable be met when this item is replaced

return_termsarray of object

Terms that are applicable when this item is returned

xinputall of

Additional input required from the customer to purchase / avail this item

timeall of

Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.

rateableboolean

Whether this item can be rated

ratingall of

The rating of the item

matchedboolean

Whether this item is an exact match of the request

relatedboolean

Whether this item is a related item to the exactly matched item

recommendedboolean

Whether this item is a recommended item to a response

ttlstring

Time to live in seconds for an instance of this schema

tagsarray of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/inventory/addOn/unblock', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

default

{
  "id": "text",
  "parent_item_id": {},
  "parent_item_quantity": {
    "allocated": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "available": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "maximum": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "minimum": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "selected": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "unitized": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    }
  },
  "descriptor": {
    "name": "text",
    "code": "text",
    "short_desc": "text",
    "long_desc": "text",
    "additional_desc": {
      "url": "text",
      "content_type": "text/plain"
    },
    "media": [
      {
        "mimetype": "text",
        "url": "https://example.com",
        "signature": "text",
        "dsa": "text"
      }
    ],
    "images": [
      {
        "url": "https://example.com",
        "size_type": "xs",
        "width": "text",
        "height": "text"
      }
    ]
  },
  "creator": {
    "descriptor": {
      "name": "text",
      "code": "text",
      "short_desc": "text",
      "long_desc": "text",
      "additional_desc": {
        "url": "text",
        "content_type": "text/plain"
      },
      "media": [
        {
          "mimetype": "text",
          "url": "https://example.com",
          "signature": "text",
          "dsa": "text"
        }
      ],
      "images": [
        {
          "url": "https://example.com",
          "size_type": "xs",
          "width": "text",
          "height": "text"
        }
      ]
    },
    "address": {},
    "state": {
      "name": "text",
      "code": "text"
    },
    "city": {
      "name": "text",
      "code": "text"
    },
    "contact": {
      "phone": "text",
      "email": "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": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "available": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "maximum": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "minimum": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "selected": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "unitized": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    }
  },
  "category_ids": [
    {}
  ],
  "fulfillment_ids": [
    {}
  ],
  "location_ids": [
    {}
  ],
  "payment_ids": [
    {}
  ],
  "add_ons": [
    {
      "id": "text",
      "descriptor": {
        "name": "text",
        "code": "text",
        "short_desc": "text",
        "long_desc": "text",
        "additional_desc": {
          "url": "text",
          "content_type": "text/plain"
        },
        "media": [
          {
            "mimetype": "text",
            "url": "https://example.com",
            "signature": "text",
            "dsa": "text"
          }
        ],
        "images": [
          {
            "url": "https://example.com",
            "size_type": "xs",
            "width": "text",
            "height": "text"
          }
        ]
      },
      "price": {
        "currency": "text",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "listed_value": "text",
        "offered_value": "text",
        "minimum_value": "text",
        "maximum_value": "text"
      }
    }
  ],
  "cancellation_terms": [
    {
      "fulfillment_state": {
        "descriptor": {
          "name": "text",
          "code": "text",
          "short_desc": "text",
          "long_desc": "text",
          "additional_desc": {
            "url": "text",
            "content_type": "text/plain"
          },
          "media": [
            {
              "mimetype": "text",
              "url": "https://example.com",
              "signature": "text",
              "dsa": "text"
            }
          ],
          "images": [
            {
              "url": "https://example.com",
              "size_type": "xs",
              "width": "text",
              "height": "text"
            }
          ]
        },
        "updated_at": "2025-01-30T22:23:34.191Z",
        "updated_by": "text"
      },
      "reason_required": false,
      "cancel_by": {
        "label": "text",
        "timestamp": "2025-01-30T22:23:34.191Z",
        "duration": "text",
        "range": {
          "start": "2025-01-30T22:23:34.191Z",
          "end": "2025-01-30T22:23:34.191Z"
        },
        "days": "text",
        "schedule": {
          "frequency": "text",
          "holidays": [
            "2025-01-30T22:23:34.191Z"
          ],
          "times": [
            "2025-01-30T22:23:34.191Z"
          ]
        }
      },
      "cancellation_fee": {
        "percentage": {},
        "amount": {
          "currency": "text",
          "value": "text",
          "estimated_value": "text",
          "computed_value": "text",
          "listed_value": "text",
          "offered_value": "text",
          "minimum_value": "text",
          "maximum_value": "text"
        }
      },
      "xinput": {
        "id": "text",
        "head": {
          "descriptor": {
            "id": "text",
            "url": "https://example.com",
            "mime_type": "text/html",
            "submission_id": "123e4567-e89b-12d3-a456-426614174000"
          },
          "index": {
            "cur": 0,
            "max": 0,
            "min": 0
          },
          "headings": [
            "text"
          ]
        },
        "form": {
          "id": "text",
          "url": "https://example.com",
          "mime_type": "text/html",
          "submission_id": "123e4567-e89b-12d3-a456-426614174000"
        },
        "required": false
      },
      "external_ref": {
        "mimetype": "text",
        "url": "https://example.com",
        "signature": "text",
        "dsa": "text"
      }
    }
  ],
  "refund_terms": [
    {
      "fulfillment_state": {
        "name": "text",
        "code": "text"
      },
      "refund_eligible": false,
      "refund_within": {
        "label": "text",
        "timestamp": "2025-01-30T22:23:34.191Z",
        "duration": "text",
        "range": {
          "start": "2025-01-30T22:23:34.191Z",
          "end": "2025-01-30T22:23:34.191Z"
        },
        "days": "text",
        "schedule": {
          "frequency": "text",
          "holidays": [
            "2025-01-30T22:23:34.191Z"
          ],
          "times": [
            "2025-01-30T22:23:34.191Z"
          ]
        }
      },
      "refund_amount": {
        "currency": "text",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "listed_value": "text",
        "offered_value": "text",
        "minimum_value": "text",
        "maximum_value": "text"
      }
    }
  ],
  "replacement_terms": [
    {
      "fulfillment_state": {
        "name": "text",
        "code": "text"
      },
      "replace_within": {
        "label": "text",
        "timestamp": "2025-01-30T22:23:34.191Z",
        "duration": "text",
        "range": {
          "start": "2025-01-30T22:23:34.191Z",
          "end": "2025-01-30T22:23:34.191Z"
        },
        "days": "text",
        "schedule": {
          "frequency": "text",
          "holidays": [
            "2025-01-30T22:23:34.191Z"
          ],
          "times": [
            "2025-01-30T22:23:34.191Z"
          ]
        }
      },
      "external_ref": {
        "mimetype": "text",
        "url": "https://example.com",
        "signature": "text",
        "dsa": "text"
      }
    }
  ],
  "return_terms": [
    {
      "fulfillment_state": {
        "name": "text",
        "code": "text"
      },
      "return_eligible": false,
      "return_time": {
        "label": "text",
        "timestamp": "2025-01-30T22:23:34.191Z",
        "duration": "text",
        "range": {
          "start": "2025-01-30T22:23:34.191Z",
          "end": "2025-01-30T22:23:34.191Z"
        },
        "days": "text",
        "schedule": {
          "frequency": "text",
          "holidays": [
            "2025-01-30T22:23:34.191Z"
          ],
          "times": [
            "2025-01-30T22:23:34.191Z"
          ]
        }
      },
      "return_location": {
        "id": "text",
        "descriptor": {
          "name": "text",
          "code": "text",
          "short_desc": "text",
          "long_desc": "text",
          "additional_desc": {
            "url": "text",
            "content_type": "text/plain"
          },
          "media": [
            {
              "mimetype": "text",
              "url": "https://example.com",
              "signature": "text",
              "dsa": "text"
            }
          ],
          "images": [
            {
              "url": "https://example.com",
              "size_type": "xs",
              "width": "text",
              "height": "text"
            }
          ]
        },
        "map_url": "https://example.com",
        "gps": {},
        "address": {},
        "city": {
          "name": "text",
          "code": "text"
        },
        "district": "text",
        "state": {
          "name": "text",
          "code": "text"
        },
        "country": {
          "name": "text",
          "code": "text"
        },
        "area_code": "text",
        "circle": {
          "gps": "text",
          "radius": {
            "type": "CONSTANT",
            "value": "text",
            "estimated_value": "text",
            "computed_value": "text",
            "range": {
              "min": "text",
              "max": "text"
            },
            "unit": "text"
          }
        },
        "polygon": "text",
        "3dspace": "text",
        "rating": {}
      },
      "fulfillment_managed_by": "CONSUMER"
    }
  ],
  "xinput": {
    "id": "text",
    "head": {
      "descriptor": {
        "id": "text",
        "url": "https://example.com",
        "mime_type": "text/html",
        "submission_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "index": {
        "cur": 0,
        "max": 0,
        "min": 0
      },
      "headings": [
        "text"
      ]
    },
    "form": {
      "id": "text",
      "url": "https://example.com",
      "mime_type": "text/html",
      "submission_id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "required": false
  },
  "time": {
    "label": "text",
    "timestamp": "2025-01-30T22:23:34.191Z",
    "duration": "text",
    "range": {
      "start": "2025-01-30T22:23:34.191Z",
      "end": "2025-01-30T22:23:34.191Z"
    },
    "days": "text",
    "schedule": {
      "frequency": "text",
      "holidays": [
        "2025-01-30T22:23:34.191Z"
      ],
      "times": [
        "2025-01-30T22:23:34.191Z"
      ]
    }
  },
  "rateable": false,
  "rating": {},
  "matched": false,
  "related": false,
  "recommended": false,
  "ttl": "text",
  "tags": [
    {
      "display": true,
      "descriptor": {
        "name": "text",
        "code": "text",
        "short_desc": "text",
        "long_desc": "text",
        "additional_desc": {
          "url": "text",
          "content_type": "text/plain"
        },
        "media": [
          {
            "mimetype": "text",
            "url": "https://example.com",
            "signature": "text",
            "dsa": "text"
          }
        ],
        "images": [
          {
            "url": "https://example.com",
            "size_type": "xs",
            "width": "text",
            "height": "text"
          }
        ]
      },
      "list": [
        {
          "descriptor": {
            "name": "text",
            "code": "text",
            "short_desc": "text",
            "long_desc": "text",
            "additional_desc": {
              "url": "text",
              "content_type": "text/plain"
            },
            "media": [
              {
                "mimetype": "text",
                "url": "https://example.com",
                "signature": "text",
                "dsa": "text"
              }
            ],
            "images": [
              {
                "url": "https://example.com",
                "size_type": "xs",
                "width": "text",
                "height": "text"
              }
            ]
          },
          "value": "text",
          "display": false
        }
      ]
    }
  ]
}

Block add-on in inventory

POSThttps://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/inventory/addOn/block

Body

application/json

idstring

ID of the item.

parent_item_idall of

ID of the item, this item is a variant of

parent_item_quantityall of

The number of units of the parent item this item is a multiple of

descriptorall of

Physical description of the item

creatorall of

The creator of this item

priceall of

The price of this item, if it has intrinsic value

quantityall of

The selling quantity of the item

category_idsarray of all of

Categories this item can be listed under

fulfillment_idsarray of all of

Modes through which this item can be fulfilled

location_idsarray of all of

Provider Locations this item is available in

payment_idsarray of all of

Payment modalities through which this item can be ordered

add_onsarray of object

cancellation_termsarray of object

Cancellation terms of this item

refund_termsarray of object

Refund terms of this item

replacement_termsarray of object

Terms that are applicable be met when this item is replaced

return_termsarray of object

Terms that are applicable when this item is returned

xinputall of

Additional input required from the customer to purchase / avail this item

timeall of

Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.

rateableboolean

Whether this item can be rated

ratingall of

The rating of the item

matchedboolean

Whether this item is an exact match of the request

relatedboolean

Whether this item is a related item to the exactly matched item

recommendedboolean

Whether this item is a recommended item to a response

ttlstring

Time to live in seconds for an instance of this schema

tagsarray of object

Response

default

Successful fetch of resources from the catalog

Body

application/json

idstring

ID of the item.

parent_item_idall of

ID of the item, this item is a variant of

parent_item_quantityall of

The number of units of the parent item this item is a multiple of

descriptorall of

Physical description of the item

creatorall of

The creator of this item

priceall of

The price of this item, if it has intrinsic value

quantityall of

The selling quantity of the item

category_idsarray of all of

Categories this item can be listed under

fulfillment_idsarray of all of

Modes through which this item can be fulfilled

location_idsarray of all of

Provider Locations this item is available in

payment_idsarray of all of

Payment modalities through which this item can be ordered

add_onsarray of object

cancellation_termsarray of object

Cancellation terms of this item

refund_termsarray of object

Refund terms of this item

replacement_termsarray of object

Terms that are applicable be met when this item is replaced

return_termsarray of object

Terms that are applicable when this item is returned

xinputall of

Additional input required from the customer to purchase / avail this item

timeall of

Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.

rateableboolean

Whether this item can be rated

ratingall of

The rating of the item

matchedboolean

Whether this item is an exact match of the request

relatedboolean

Whether this item is a related item to the exactly matched item

recommendedboolean

Whether this item is a recommended item to a response

ttlstring

Time to live in seconds for an instance of this schema

tagsarray of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/inventory/addOn/block', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

default

{
  "id": "text",
  "parent_item_id": {},
  "parent_item_quantity": {
    "allocated": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "available": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "maximum": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "minimum": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "selected": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "unitized": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    }
  },
  "descriptor": {
    "name": "text",
    "code": "text",
    "short_desc": "text",
    "long_desc": "text",
    "additional_desc": {
      "url": "text",
      "content_type": "text/plain"
    },
    "media": [
      {
        "mimetype": "text",
        "url": "https://example.com",
        "signature": "text",
        "dsa": "text"
      }
    ],
    "images": [
      {
        "url": "https://example.com",
        "size_type": "xs",
        "width": "text",
        "height": "text"
      }
    ]
  },
  "creator": {
    "descriptor": {
      "name": "text",
      "code": "text",
      "short_desc": "text",
      "long_desc": "text",
      "additional_desc": {
        "url": "text",
        "content_type": "text/plain"
      },
      "media": [
        {
          "mimetype": "text",
          "url": "https://example.com",
          "signature": "text",
          "dsa": "text"
        }
      ],
      "images": [
        {
          "url": "https://example.com",
          "size_type": "xs",
          "width": "text",
          "height": "text"
        }
      ]
    },
    "address": {},
    "state": {
      "name": "text",
      "code": "text"
    },
    "city": {
      "name": "text",
      "code": "text"
    },
    "contact": {
      "phone": "text",
      "email": "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": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "available": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "maximum": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "minimum": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "selected": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "unitized": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    }
  },
  "category_ids": [
    {}
  ],
  "fulfillment_ids": [
    {}
  ],
  "location_ids": [
    {}
  ],
  "payment_ids": [
    {}
  ],
  "add_ons": [
    {
      "id": "text",
      "descriptor": {
        "name": "text",
        "code": "text",
        "short_desc": "text",
        "long_desc": "text",
        "additional_desc": {
          "url": "text",
          "content_type": "text/plain"
        },
        "media": [
          {
            "mimetype": "text",
            "url": "https://example.com",
            "signature": "text",
            "dsa": "text"
          }
        ],
        "images": [
          {
            "url": "https://example.com",
            "size_type": "xs",
            "width": "text",
            "height": "text"
          }
        ]
      },
      "price": {
        "currency": "text",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "listed_value": "text",
        "offered_value": "text",
        "minimum_value": "text",
        "maximum_value": "text"
      }
    }
  ],
  "cancellation_terms": [
    {
      "fulfillment_state": {
        "descriptor": {
          "name": "text",
          "code": "text",
          "short_desc": "text",
          "long_desc": "text",
          "additional_desc": {
            "url": "text",
            "content_type": "text/plain"
          },
          "media": [
            {
              "mimetype": "text",
              "url": "https://example.com",
              "signature": "text",
              "dsa": "text"
            }
          ],
          "images": [
            {
              "url": "https://example.com",
              "size_type": "xs",
              "width": "text",
              "height": "text"
            }
          ]
        },
        "updated_at": "2025-01-30T22:23:34.191Z",
        "updated_by": "text"
      },
      "reason_required": false,
      "cancel_by": {
        "label": "text",
        "timestamp": "2025-01-30T22:23:34.191Z",
        "duration": "text",
        "range": {
          "start": "2025-01-30T22:23:34.191Z",
          "end": "2025-01-30T22:23:34.191Z"
        },
        "days": "text",
        "schedule": {
          "frequency": "text",
          "holidays": [
            "2025-01-30T22:23:34.191Z"
          ],
          "times": [
            "2025-01-30T22:23:34.191Z"
          ]
        }
      },
      "cancellation_fee": {
        "percentage": {},
        "amount": {
          "currency": "text",
          "value": "text",
          "estimated_value": "text",
          "computed_value": "text",
          "listed_value": "text",
          "offered_value": "text",
          "minimum_value": "text",
          "maximum_value": "text"
        }
      },
      "xinput": {
        "id": "text",
        "head": {
          "descriptor": {
            "id": "text",
            "url": "https://example.com",
            "mime_type": "text/html",
            "submission_id": "123e4567-e89b-12d3-a456-426614174000"
          },
          "index": {
            "cur": 0,
            "max": 0,
            "min": 0
          },
          "headings": [
            "text"
          ]
        },
        "form": {
          "id": "text",
          "url": "https://example.com",
          "mime_type": "text/html",
          "submission_id": "123e4567-e89b-12d3-a456-426614174000"
        },
        "required": false
      },
      "external_ref": {
        "mimetype": "text",
        "url": "https://example.com",
        "signature": "text",
        "dsa": "text"
      }
    }
  ],
  "refund_terms": [
    {
      "fulfillment_state": {
        "name": "text",
        "code": "text"
      },
      "refund_eligible": false,
      "refund_within": {
        "label": "text",
        "timestamp": "2025-01-30T22:23:34.191Z",
        "duration": "text",
        "range": {
          "start": "2025-01-30T22:23:34.191Z",
          "end": "2025-01-30T22:23:34.191Z"
        },
        "days": "text",
        "schedule": {
          "frequency": "text",
          "holidays": [
            "2025-01-30T22:23:34.191Z"
          ],
          "times": [
            "2025-01-30T22:23:34.191Z"
          ]
        }
      },
      "refund_amount": {
        "currency": "text",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "listed_value": "text",
        "offered_value": "text",
        "minimum_value": "text",
        "maximum_value": "text"
      }
    }
  ],
  "replacement_terms": [
    {
      "fulfillment_state": {
        "name": "text",
        "code": "text"
      },
      "replace_within": {
        "label": "text",
        "timestamp": "2025-01-30T22:23:34.191Z",
        "duration": "text",
        "range": {
          "start": "2025-01-30T22:23:34.191Z",
          "end": "2025-01-30T22:23:34.191Z"
        },
        "days": "text",
        "schedule": {
          "frequency": "text",
          "holidays": [
            "2025-01-30T22:23:34.191Z"
          ],
          "times": [
            "2025-01-30T22:23:34.191Z"
          ]
        }
      },
      "external_ref": {
        "mimetype": "text",
        "url": "https://example.com",
        "signature": "text",
        "dsa": "text"
      }
    }
  ],
  "return_terms": [
    {
      "fulfillment_state": {
        "name": "text",
        "code": "text"
      },
      "return_eligible": false,
      "return_time": {
        "label": "text",
        "timestamp": "2025-01-30T22:23:34.191Z",
        "duration": "text",
        "range": {
          "start": "2025-01-30T22:23:34.191Z",
          "end": "2025-01-30T22:23:34.191Z"
        },
        "days": "text",
        "schedule": {
          "frequency": "text",
          "holidays": [
            "2025-01-30T22:23:34.191Z"
          ],
          "times": [
            "2025-01-30T22:23:34.191Z"
          ]
        }
      },
      "return_location": {
        "id": "text",
        "descriptor": {
          "name": "text",
          "code": "text",
          "short_desc": "text",
          "long_desc": "text",
          "additional_desc": {
            "url": "text",
            "content_type": "text/plain"
          },
          "media": [
            {
              "mimetype": "text",
              "url": "https://example.com",
              "signature": "text",
              "dsa": "text"
            }
          ],
          "images": [
            {
              "url": "https://example.com",
              "size_type": "xs",
              "width": "text",
              "height": "text"
            }
          ]
        },
        "map_url": "https://example.com",
        "gps": {},
        "address": {},
        "city": {
          "name": "text",
          "code": "text"
        },
        "district": "text",
        "state": {
          "name": "text",
          "code": "text"
        },
        "country": {
          "name": "text",
          "code": "text"
        },
        "area_code": "text",
        "circle": {
          "gps": "text",
          "radius": {
            "type": "CONSTANT",
            "value": "text",
            "estimated_value": "text",
            "computed_value": "text",
            "range": {
              "min": "text",
              "max": "text"
            },
            "unit": "text"
          }
        },
        "polygon": "text",
        "3dspace": "text",
        "rating": {}
      },
      "fulfillment_managed_by": "CONSUMER"
    }
  ],
  "xinput": {
    "id": "text",
    "head": {
      "descriptor": {
        "id": "text",
        "url": "https://example.com",
        "mime_type": "text/html",
        "submission_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "index": {
        "cur": 0,
        "max": 0,
        "min": 0
      },
      "headings": [
        "text"
      ]
    },
    "form": {
      "id": "text",
      "url": "https://example.com",
      "mime_type": "text/html",
      "submission_id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "required": false
  },
  "time": {
    "label": "text",
    "timestamp": "2025-01-30T22:23:34.191Z",
    "duration": "text",
    "range": {
      "start": "2025-01-30T22:23:34.191Z",
      "end": "2025-01-30T22:23:34.191Z"
    },
    "days": "text",
    "schedule": {
      "frequency": "text",
      "holidays": [
        "2025-01-30T22:23:34.191Z"
      ],
      "times": [
        "2025-01-30T22:23:34.191Z"
      ]
    }
  },
  "rateable": false,
  "rating": {},
  "matched": false,
  "related": false,
  "recommended": false,
  "ttl": "text",
  "tags": [
    {
      "display": true,
      "descriptor": {
        "name": "text",
        "code": "text",
        "short_desc": "text",
        "long_desc": "text",
        "additional_desc": {
          "url": "text",
          "content_type": "text/plain"
        },
        "media": [
          {
            "mimetype": "text",
            "url": "https://example.com",
            "signature": "text",
            "dsa": "text"
          }
        ],
        "images": [
          {
            "url": "https://example.com",
            "size_type": "xs",
            "width": "text",
            "height": "text"
          }
        ]
      },
      "list": [
        {
          "descriptor": {
            "name": "text",
            "code": "text",
            "short_desc": "text",
            "long_desc": "text",
            "additional_desc": {
              "url": "text",
              "content_type": "text/plain"
            },
            "media": [
              {
                "mimetype": "text",
                "url": "https://example.com",
                "signature": "text",
                "dsa": "text"
              }
            ],
            "images": [
              {
                "url": "https://example.com",
                "size_type": "xs",
                "width": "text",
                "height": "text"
              }
            ]
          },
          "value": "text",
          "display": false
        }
      ]
    }
  ]
}

Add Item to inventory

POSThttps://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/inventory/item/unblock

Body

application/json

idstring

ID of the item.

parent_item_idall of

ID of the item, this item is a variant of

parent_item_quantityall of

The number of units of the parent item this item is a multiple of

descriptorall of

Physical description of the item

creatorall of

The creator of this item

priceall of

The price of this item, if it has intrinsic value

quantityall of

The selling quantity of the item

category_idsarray of all of

Categories this item can be listed under

fulfillment_idsarray of all of

Modes through which this item can be fulfilled

location_idsarray of all of

Provider Locations this item is available in

payment_idsarray of all of

Payment modalities through which this item can be ordered

add_onsarray of object

cancellation_termsarray of object

Cancellation terms of this item

refund_termsarray of object

Refund terms of this item

replacement_termsarray of object

Terms that are applicable be met when this item is replaced

return_termsarray of object

Terms that are applicable when this item is returned

xinputall of

Additional input required from the customer to purchase / avail this item

timeall of

Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.

rateableboolean

Whether this item can be rated

ratingall of

The rating of the item

matchedboolean

Whether this item is an exact match of the request

relatedboolean

Whether this item is a related item to the exactly matched item

recommendedboolean

Whether this item is a recommended item to a response

ttlstring

Time to live in seconds for an instance of this schema

tagsarray of object

Response

default

Successful fetch of resources from the catalog

Body

application/json

idstring

ID of the item.

parent_item_idall of

ID of the item, this item is a variant of

parent_item_quantityall of

The number of units of the parent item this item is a multiple of

descriptorall of

Physical description of the item

creatorall of

The creator of this item

priceall of

The price of this item, if it has intrinsic value

quantityall of

The selling quantity of the item

category_idsarray of all of

Categories this item can be listed under

fulfillment_idsarray of all of

Modes through which this item can be fulfilled

location_idsarray of all of

Provider Locations this item is available in

payment_idsarray of all of

Payment modalities through which this item can be ordered

add_onsarray of object

cancellation_termsarray of object

Cancellation terms of this item

refund_termsarray of object

Refund terms of this item

replacement_termsarray of object

Terms that are applicable be met when this item is replaced

return_termsarray of object

Terms that are applicable when this item is returned

xinputall of

Additional input required from the customer to purchase / avail this item

timeall of

Temporal attributes of this item. This property is used when the item exists on the catalog only for a limited period of time.

rateableboolean

Whether this item can be rated

ratingall of

The rating of the item

matchedboolean

Whether this item is an exact match of the request

relatedboolean

Whether this item is a related item to the exactly matched item

recommendedboolean

Whether this item is a recommended item to a response

ttlstring

Time to live in seconds for an instance of this schema

tagsarray of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/inventory/item/unblock', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

default

{
  "id": "text",
  "parent_item_id": {},
  "parent_item_quantity": {
    "allocated": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "available": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "maximum": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "minimum": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "selected": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "unitized": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    }
  },
  "descriptor": {
    "name": "text",
    "code": "text",
    "short_desc": "text",
    "long_desc": "text",
    "additional_desc": {
      "url": "text",
      "content_type": "text/plain"
    },
    "media": [
      {
        "mimetype": "text",
        "url": "https://example.com",
        "signature": "text",
        "dsa": "text"
      }
    ],
    "images": [
      {
        "url": "https://example.com",
        "size_type": "xs",
        "width": "text",
        "height": "text"
      }
    ]
  },
  "creator": {
    "descriptor": {
      "name": "text",
      "code": "text",
      "short_desc": "text",
      "long_desc": "text",
      "additional_desc": {
        "url": "text",
        "content_type": "text/plain"
      },
      "media": [
        {
          "mimetype": "text",
          "url": "https://example.com",
          "signature": "text",
          "dsa": "text"
        }
      ],
      "images": [
        {
          "url": "https://example.com",
          "size_type": "xs",
          "width": "text",
          "height": "text"
        }
      ]
    },
    "address": {},
    "state": {
      "name": "text",
      "code": "text"
    },
    "city": {
      "name": "text",
      "code": "text"
    },
    "contact": {
      "phone": "text",
      "email": "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": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "available": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "maximum": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "minimum": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "selected": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    },
    "unitized": {
      "count": 0,
      "measure": {
        "type": "CONSTANT",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "range": {
          "min": "text",
          "max": "text"
        },
        "unit": "text"
      }
    }
  },
  "category_ids": [
    {}
  ],
  "fulfillment_ids": [
    {}
  ],
  "location_ids": [
    {}
  ],
  "payment_ids": [
    {}
  ],
  "add_ons": [
    {
      "id": "text",
      "descriptor": {
        "name": "text",
        "code": "text",
        "short_desc": "text",
        "long_desc": "text",
        "additional_desc": {
          "url": "text",
          "content_type": "text/plain"
        },
        "media": [
          {
            "mimetype": "text",
            "url": "https://example.com",
            "signature": "text",
            "dsa": "text"
          }
        ],
        "images": [
          {
            "url": "https://example.com",
            "size_type": "xs",
            "width": "text",
            "height": "text"
          }
        ]
      },
      "price": {
        "currency": "text",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "listed_value": "text",
        "offered_value": "text",
        "minimum_value": "text",
        "maximum_value": "text"
      }
    }
  ],
  "cancellation_terms": [
    {
      "fulfillment_state": {
        "descriptor": {
          "name": "text",
          "code": "text",
          "short_desc": "text",
          "long_desc": "text",
          "additional_desc": {
            "url": "text",
            "content_type": "text/plain"
          },
          "media": [
            {
              "mimetype": "text",
              "url": "https://example.com",
              "signature": "text",
              "dsa": "text"
            }
          ],
          "images": [
            {
              "url": "https://example.com",
              "size_type": "xs",
              "width": "text",
              "height": "text"
            }
          ]
        },
        "updated_at": "2025-01-30T22:23:34.191Z",
        "updated_by": "text"
      },
      "reason_required": false,
      "cancel_by": {
        "label": "text",
        "timestamp": "2025-01-30T22:23:34.191Z",
        "duration": "text",
        "range": {
          "start": "2025-01-30T22:23:34.191Z",
          "end": "2025-01-30T22:23:34.191Z"
        },
        "days": "text",
        "schedule": {
          "frequency": "text",
          "holidays": [
            "2025-01-30T22:23:34.191Z"
          ],
          "times": [
            "2025-01-30T22:23:34.191Z"
          ]
        }
      },
      "cancellation_fee": {
        "percentage": {},
        "amount": {
          "currency": "text",
          "value": "text",
          "estimated_value": "text",
          "computed_value": "text",
          "listed_value": "text",
          "offered_value": "text",
          "minimum_value": "text",
          "maximum_value": "text"
        }
      },
      "xinput": {
        "id": "text",
        "head": {
          "descriptor": {
            "id": "text",
            "url": "https://example.com",
            "mime_type": "text/html",
            "submission_id": "123e4567-e89b-12d3-a456-426614174000"
          },
          "index": {
            "cur": 0,
            "max": 0,
            "min": 0
          },
          "headings": [
            "text"
          ]
        },
        "form": {
          "id": "text",
          "url": "https://example.com",
          "mime_type": "text/html",
          "submission_id": "123e4567-e89b-12d3-a456-426614174000"
        },
        "required": false
      },
      "external_ref": {
        "mimetype": "text",
        "url": "https://example.com",
        "signature": "text",
        "dsa": "text"
      }
    }
  ],
  "refund_terms": [
    {
      "fulfillment_state": {
        "name": "text",
        "code": "text"
      },
      "refund_eligible": false,
      "refund_within": {
        "label": "text",
        "timestamp": "2025-01-30T22:23:34.191Z",
        "duration": "text",
        "range": {
          "start": "2025-01-30T22:23:34.191Z",
          "end": "2025-01-30T22:23:34.191Z"
        },
        "days": "text",
        "schedule": {
          "frequency": "text",
          "holidays": [
            "2025-01-30T22:23:34.191Z"
          ],
          "times": [
            "2025-01-30T22:23:34.191Z"
          ]
        }
      },
      "refund_amount": {
        "currency": "text",
        "value": "text",
        "estimated_value": "text",
        "computed_value": "text",
        "listed_value": "text",
        "offered_value": "text",
        "minimum_value": "text",
        "maximum_value": "text"
      }
    }
  ],
  "replacement_terms": [
    {
      "fulfillment_state": {
        "name": "text",
        "code": "text"
      },
      "replace_within": {
        "label": "text",
        "timestamp": "2025-01-30T22:23:34.191Z",
        "duration": "text",
        "range": {
          "start": "2025-01-30T22:23:34.191Z",
          "end": "2025-01-30T22:23:34.191Z"
        },
        "days": "text",
        "schedule": {
          "frequency": "text",
          "holidays": [
            "2025-01-30T22:23:34.191Z"
          ],
          "times": [
            "2025-01-30T22:23:34.191Z"
          ]
        }
      },
      "external_ref": {
        "mimetype": "text",
        "url": "https://example.com",
        "signature": "text",
        "dsa": "text"
      }
    }
  ],
  "return_terms": [
    {
      "fulfillment_state": {
        "name": "text",
        "code": "text"
      },
      "return_eligible": false,
      "return_time": {
        "label": "text",
        "timestamp": "2025-01-30T22:23:34.191Z",
        "duration": "text",
        "range": {
          "start": "2025-01-30T22:23:34.191Z",
          "end": "2025-01-30T22:23:34.191Z"
        },
        "days": "text",
        "schedule": {
          "frequency": "text",
          "holidays": [
            "2025-01-30T22:23:34.191Z"
          ],
          "times": [
            "2025-01-30T22:23:34.191Z"
          ]
        }
      },
      "return_location": {
        "id": "text",
        "descriptor": {
          "name": "text",
          "code": "text",
          "short_desc": "text",
          "long_desc": "text",
          "additional_desc": {
            "url": "text",
            "content_type": "text/plain"
          },
          "media": [
            {
              "mimetype": "text",
              "url": "https://example.com",
              "signature": "text",
              "dsa": "text"
            }
          ],
          "images": [
            {
              "url": "https://example.com",
              "size_type": "xs",
              "width": "text",
              "height": "text"
            }
          ]
        },
        "map_url": "https://example.com",
        "gps": {},
        "address": {},
        "city": {
          "name": "text",
          "code": "text"
        },
        "district": "text",
        "state": {
          "name": "text",
          "code": "text"
        },
        "country": {
          "name": "text",
          "code": "text"
        },
        "area_code": "text",
        "circle": {
          "gps": "text",
          "radius": {
            "type": "CONSTANT",
            "value": "text",
            "estimated_value": "text",
            "computed_value": "text",
            "range": {
              "min": "text",
              "max": "text"
            },
            "unit": "text"
          }
        },
        "polygon": "text",
        "3dspace": "text",
        "rating": {}
      },
      "fulfillment_managed_by": "CONSUMER"
    }
  ],
  "xinput": {
    "id": "text",
    "head": {
      "descriptor": {
        "id": "text",
        "url": "https://example.com",
        "mime_type": "text/html",
        "submission_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "index": {
        "cur": 0,
        "max": 0,
        "min": 0
      },
      "headings": [
        "text"
      ]
    },
    "form": {
      "id": "text",
      "url": "https://example.com",
      "mime_type": "text/html",
      "submission_id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "required": false
  },
  "time": {
    "label": "text",
    "timestamp": "2025-01-30T22:23:34.191Z",
    "duration": "text",
    "range": {
      "start": "2025-01-30T22:23:34.191Z",
      "end": "2025-01-30T22:23:34.191Z"
    },
    "days": "text",
    "schedule": {
      "frequency": "text",
      "holidays": [
        "2025-01-30T22:23:34.191Z"
      ],
      "times": [
        "2025-01-30T22:23:34.191Z"
      ]
    }
  },
  "rateable": false,
  "rating": {},
  "matched": false,
  "related": false,
  "recommended": false,
  "ttl": "text",
  "tags": [
    {
      "display": true,
      "descriptor": {
        "name": "text",
        "code": "text",
        "short_desc": "text",
        "long_desc": "text",
        "additional_desc": {
          "url": "text",
          "content_type": "text/plain"
        },
        "media": [
          {
            "mimetype": "text",
            "url": "https://example.com",
            "signature": "text",
            "dsa": "text"
          }
        ],
        "images": [
          {
            "url": "https://example.com",
            "size_type": "xs",
            "width": "text",
            "height": "text"
          }
        ]
      },
      "list": [
        {
          "descriptor": {
            "name": "text",
            "code": "text",
            "short_desc": "text",
            "long_desc": "text",
            "additional_desc": {
              "url": "text",
              "content_type": "text/plain"
            },
            "media": [
              {
                "mimetype": "text",
                "url": "https://example.com",
                "signature": "text",
                "dsa": "text"
              }
            ],
            "images": [
              {
                "url": "https://example.com",
                "size_type": "xs",
                "width": "text",
                "height": "text"
              }
            ]
          },
          "value": "text",
          "display": false
        }
      ]
    }
  ]
}