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.

post

Consumer Interface declares the customer's intent to buy/avail products or services

Body

application/json

Responses

default

Acknowledgement of message received after successful validation of schema and signature

application/json

post

/search

HTTPcURLJavaScriptPython

POST /beckn/e-marketplace-bb/0.2/search HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 44718

{
  "context": {
    "domain": {},
    "location": {
      "id": "text",
      "descriptor": {
        "name": "text",
        "code": "text",
        "short_desc": "text",
        "long_desc": "text",
        "additional_desc": {
          "url": "text",
          "content_type": "text/plain"
        },
        "media": [
          {
            "mimetype": "text",
            "url": "https://example.com",
            "signature": "text",
            "dsa": "text"
          }
        ],
        "images": [
          {
            "url": "https://example.com",
            "size_type": "xs",
            "width": "text",
            "height": "text"
          }
        ]
      },
      "map_url": "https://example.com",
      "gps": "text",
      "address": "text",
      "city": {
        "name": "text",
        "code": "text"
      },
      "district": "text",
      "state": {
        "name": "text",
        "code": "text"
      },
      "country": {
        "name": "text",
        "code": "text"
      },
      "area_code": "text",
      "circle": {
        "gps": "text",
        "radius": {
          "type": "CONSTANT",
          "value": "text",
          "estimated_value": "text",
          "computed_value": "text",
          "range": {
            "min": "text",
            "max": "text"
          },
          "unit": "text"
        }
      },
      "polygon": "text",
      "3dspace": "text",
      "rating": "text"
    },
    "action": "search",
    "version": "text",
    "bap_id": "text",
    "bap_uri": "https://example.com",
    "bpp_id": "text",
    "bpp_uri": "https://example.com",
    "transaction_id": "123e4567-e89b-12d3-a456-426614174000",
    "message_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2026-05-10T06:51:04.563Z",
    "key": "text",
    "ttl": "text"
  },
  "message": {
    "intent": {
      "descriptor": {
        "name": "text",
        "code": "text",
        "short_desc": "text",
        "long_desc": "text",
        "additional_desc": {
          "url": "text",
          "content_type": "text/plain"
        },
        "media": [
          {
            "mimetype": "text",
            "url": "https://example.com",
            "signature": "text",
            "dsa": "text"
          }
        ],
        "images": [
          {
            "url": "https://example.com",
            "size_type": "xs",
            "width": "text",
            "height": "text"
          }
        ]
      },
      "provider": {
        "id": "text",
        "descriptor": {
          "name": "text",
          "code": "text",
          "short_desc": "text",
          "long_desc": "text",
          "additional_desc": {
            "url": "text",
            "content_type": "text/plain"
          },
          "media": [
            {
              "mimetype": "text",
              "url": "https://example.com",
              "signature": "text",
              "dsa": "text"
            }
          ],
          "images": [
            {
              "url": "https://example.com",
              "size_type": "xs",
              "width": "text",
              "height": "text"
            }
          ]
        },
        "category_id": "text",
        "rating": "text",
        "time": {
          "label": "text",
          "timestamp": "2026-05-10T06:51:04.563Z",
          "duration": "text",
          "range": {
            "start": "2026-05-10T06:51:04.563Z",
            "end": "2026-05-10T06:51:04.563Z"
          },
          "days": "text",
          "schedule": {
            "frequency": "text",
            "holidays": [
              "2026-05-10T06:51:04.563Z"
            ],
            "times": [
              "2026-05-10T06:51:04.563Z"
            ]
          }
        },
        "categories": [
          {
            "id": "text",
            "parent_category_id": "text",
            "descriptor": {
              "name": "text",
              "code": "text",
              "short_desc": "text",
              "long_desc": "text",
              "additional_desc": {
                "url": "text",
                "content_type": "text/plain"
              },
              "media": [
                {
                  "mimetype": "text",
                  "url": "https://example.com",
                  "signature": "text",
                  "dsa": "text"
                }
              ],
              "images": [
                {
                  "url": "https://example.com",
                  "size_type": "xs",
                  "width": "text",
                  "height": "text"
                }
              ]
            },
            "time": {
              "label": "text",
              "timestamp": "2026-05-10T06:51:04.563Z",
              "duration": "text",
              "range": {
                "start": "2026-05-10T06:51:04.563Z",
                "end": "2026-05-10T06:51:04.563Z"
              },
              "days": "text",
              "schedule": {
                "frequency": "text",
                "holidays": [
                  "2026-05-10T06:51:04.563Z"
                ],
                "times": [
                  "2026-05-10T06:51:04.563Z"
                ]
              }
            },
            "ttl": null,
            "tags": [
              {
                "display": true,
                "descriptor": {
                  "name": "text",
                  "code": "text",
                  "short_desc": "text",
                  "long_desc": "text",
                  "additional_desc": {
                    "url": "text",
                    "content_type": "text/plain"
                  },
                  "media": [
                    {
                      "mimetype": "text",
                      "url": "https://example.com",
                      "signature": "text",
                      "dsa": "text"
                    }
                  ],
                  "images": [
                    {
                      "url": "https://example.com",
                      "size_type": "xs",
                      "width": "text",
                      "height": "text"
                    }
                  ]
                },
                "list": [
                  {
                    "descriptor": {
                      "name": "text",
                      "code": "text",
                      "short_desc": "text",
                      "long_desc": "text",
                      "additional_desc": {
                        "url": "text",
                        "content_type": "text/plain"
                      },
                      "media": [
                        {
                          "mimetype": "text",
                          "url": "https://example.com",
                          "signature": "text",
                          "dsa": "text"
                        }
                      ],
                      "images": [
                        {
                          "url": "https://example.com",
                          "size_type": "xs",
                          "width": "text",
                          "height": "text"
                        }
                      ]
                    },
                    "value": "text",
                    "display": true
                  }
                ]
              }
            ]
          }
        ],
        "fulfillments": [
          {
            "id": "text",
            "type": "text",
            "rateable": true,
            "rating": "text",
            "state": {
              "descriptor": {
                "name": "text",
                "code": "text",
                "short_desc": "text",
                "long_desc": "text",
                "additional_desc": {
                  "url": "text",
                  "content_type": "text/plain"
                },
                "media": [
                  {
                    "mimetype": "text",
                    "url": "https://example.com",
                    "signature": "text",
                    "dsa": "text"
                  }
                ],
                "images": [
                  {
                    "url": "https://example.com",
                    "size_type": "xs",
                    "width": "text",
                    "height": "text"
                  }
                ]
              },
              "updated_at": "2026-05-10T06:51:04.563Z",
              "updated_by": "text"
            },
            "tracking": false,
            "customer": {
              "person": {
                "id": "text",
                "url": "https://example.com",
                "name": "text",
                "image": {
                  "url": "https://example.com",
                  "size_type": "xs",
                  "width": "text",
                  "height": "text"
                },
                "age": "text",
                "dob": "2026-05-10",
                "gender": "text",
                "creds": [
                  {
                    "id": "text",
                    "type": "VerifiableCredential",
                    "url": "https://example.com"
                  }
                ],
                "languages": [
                  {
                    "code": "text",
                    "name": "text"
                  }
                ],
                "skills": [
                  {
                    "code": "text",
                    "name": "text"
                  }
                ],
                "tags": [
                  {
                    "display": true,
                    "descriptor": {
                      "name": "text",
                      "code": "text",
                      "short_desc": "text",
                      "long_desc": "text",
                      "additional_desc": {
                        "url": "text",
                        "content_type": "text/plain"
                      },
                      "media": [
                        {
                          "mimetype": "text",
                          "url": "https://example.com",
                          "signature": "text",
                          "dsa": "text"
                        }
                      ],
                      "images": [
                        {
                          "url": "https://example.com",
                          "size_type": "xs",
                          "width": "text",
                          "height": "text"
                        }
                      ]
                    },
                    "list": [
                      {
                        "descriptor": {
                          "name": "text",
                          "code": "text",
                          "short_desc": "text",
                          "long_desc": "text",
                          "additional_desc": {
                            "url": "text",
                            "content_type": "text/plain"
                          },
                          "media": [
                            {
                              "mimetype": "text",
                              "url": "https://example.com",
                              "signature": "text",
                              "dsa": "text"
                            }
                          ],
                          "images": [
                            {
                              "url": "https://example.com",
                              "size_type": "xs",
                              "width": "text",
                              "height": "text"
                            }
                          ]
                        },
                        "value": "text",
                        "display": true
                      }
                    ]
                  }
                ]
              },
              "contact": {
                "phone": "text",
                "email": "text",
                "jcard": {}
              }
            },
            "agent": {
              "id": "text",
              "person": {
                "id": "text",
                "url": "https://example.com",
                "name": "text",
                "image": {
                  "url": "https://example.com",
                  "size_type": "xs",
                  "width": "text",
                  "height": "text"
                },
                "age": "text",
                "dob": "2026-05-10",
                "gender": "text",
                "creds": [
                  {
                    "id": "text",
                    "type": "VerifiableCredential",
                    "url": "https://example.com"
                  }
                ],
                "languages": [
                  {
                    "code": "text",
                    "name": "text"
                  }
                ],
                "skills": [
                  {
                    "code": "text",
                    "name": "text"
                  }
                ],
                "tags": [
                  {
                    "display": true,
                    "descriptor": {
                      "name": "text",
                      "code": "text",
                      "short_desc": "text",
                      "long_desc": "text",
                      "additional_desc": {
                        "url": "text",
                        "content_type": "text/plain"
                      },
                      "media": [
                        {
                          "mimetype": "text",
                          "url": "https://example.com",
                          "signature": "text",
                          "dsa": "text"
                        }
                      ],
                      "images": [
                        {
                          "url": "https://example.com",
                          "size_type": "xs",
                          "width": "text",
                          "height": "text"
                        }
                      ]
                    },
                    "list": [
                      {
                        "descriptor": {
                          "name": "text",
                          "code": "text",
                          "short_desc": "text",
                          "long_desc": "text",
                          "additional_desc": {
                            "url": "text",
                            "content_type": "text/plain"
                          },
                          "media": [
                            {
                              "mimetype": "text",
                              "url": "https://example.com",
                              "signature": "text",
                              "dsa": "text"
                            }
                          ],
                          "images": [
                            {
                              "url": "https://example.com",
                              "size_type": "xs",
                              "width": "text",
                              "height": "text"
                            }
                          ]
                        },
                        "value": "text",
                        "display": true
                      }
                    ]
                  }
                ]
              },
              "contact": {
                "phone": "text",
                "email": "text",
                "jcard": {}
              },
              "organization": {
                "descriptor": {
                  "name": "text",
                  "code": "text",
                  "short_desc": "text",
                  "long_desc": "text",
                  "additional_desc": {
                    "url": "text",
                    "content_type": "text/plain"
                  },
                  "media": [
                    {
                      "mimetype": "text",
                      "url": "https://example.com",
                      "signature": "text",
                      "dsa": "text"
                    }
                  ],
                  "images": [
                    {
                      "url": "https://example.com",
                      "size_type": "xs",
                      "width": "text",
                      "height": "text"
                    }
                  ]
                },
                "address": "text",
                "state": {
                  "name": "text",
                  "code": "text"
                },
                "city": {
                  "name": "text",
                  "code": "text"
                },
                "contact": {
                  "phone": "text",
                  "email": "text",
                  "jcard": {}
                }
              },
              "rating": "text"
            },
            "contact": {
              "phone": "text",
              "email": "text",
              "jcard": {}
            },
            "vehicle": {
              "category": "text",
              "capacity": 1,
              "make": "text",
              "model": "text",
              "size": "text",
              "variant": "text",
              "color": "text",
              "energy_type": "text",
              "registration": "text",
              "wheels_count": "text",
              "cargo_volumne": "text",
              "wheelchair_access": "text",
              "code": "text",
              "emission_standard": "text"
            },
            "stops": [
              {
                "id": "text",
                "parent_stop_id": "text",
                "location": {
                  "id": "text",
                  "descriptor": {
                    "name": "text",
                    "code": "text",
                    "short_desc": "text",
                    "long_desc": "text",
                    "additional_desc": {
                      "url": "text",
                      "content_type": "text/plain"
                    },
                    "media": [
                      {
                        "mimetype": "text",
                        "url": "https://example.com",
                        "signature": "text",
                        "dsa": "text"
                      }
                    ],
                    "images": [
                      {
                        "url": "https://example.com",
                        "size_type": "xs",
                        "width": "text",
                        "height": "text"
                      }
                    ]
                  },
                  "map_url": "https://example.com",
                  "gps": "text",
                  "address": "text",
                  "city": {
                    "name": "text",
                    "code": "text"
                  },
                  "district": "text",
                  "state": {
                    "name": "text",
                    "code": "text"
                  },
                  "country": {
                    "name": "text",
                    "code": "text"
                  },
                  "area_code": "text",
                  "circle": {
                    "gps": "text",
                    "radius": {
                      "type": "CONSTANT",
                      "value": "text",
                      "estimated_value": "text",
                      "computed_value": "text",
                      "range": {
                        "min": "text",
                        "max": "text"
                      },
                      "unit": "text"
                    }
                  },
                  "polygon": "text",
                  "3dspace": "text",
                  "rating": "text"
                },
                "type": "text",
                "time": {
                  "label": "text",
                  "timestamp": "2026-05-10T06:51:04.563Z",
                  "duration": "text",
                  "range": {
                    "start": "2026-05-10T06:51:04.563Z",
                    "end": "2026-05-10T06:51:04.563Z"
                  },
                  "days": "text",
                  "schedule": {
                    "frequency": "text",
                    "holidays": [
                      "2026-05-10T06:51:04.563Z"
                    ],
                    "times": [
                      "2026-05-10T06:51:04.563Z"
                    ]
                  }
                },
                "instructions": {
                  "name": "text",
                  "code": "text",
                  "short_desc": "text",
                  "long_desc": "text",
                  "additional_desc": {
                    "url": "text",
                    "content_type": "text/plain"
                  },
                  "media": [
                    {
                      "mimetype": "text",
                      "url": "https://example.com",
                      "signature": "text",
                      "dsa": "text"
                    }
                  ],
                  "images": [
                    {
                      "url": "https://example.com",
                      "size_type": "xs",
                      "width": "text",
                      "height": "text"
                    }
                  ]
                },
                "contact": {
                  "phone": "text",
                  "email": "text",
                  "jcard": {}
                },
                "person": {
                  "id": "text",
                  "url": "https://example.com",
                  "name": "text",
                  "image": {
                    "url": "https://example.com",
                    "size_type": "xs",
                    "width": "text",
                    "height": "text"
                  },
                  "age": "text",
                  "dob": "2026-05-10",
                  "gender": "text",
                  "creds": [
                    {
                      "id": "text",
                      "type": "VerifiableCredential",
                      "url": "https://example.com"
                    }
                  ],
                  "languages": [
                    {
                      "code": "text",
                      "name": "text"
                    }
                  ],
                  "skills": [
                    {
                      "code": "text",
                      "name": "text"
                    }
                  ],
                  "tags": [
                    {
                      "display": true,
                      "descriptor": {
                        "name": "text",
                        "code": "text",
                        "short_desc": "text",
                        "long_desc": "text",
                        "additional_desc": {
                          "url": "text",
                          "content_type": "text/plain"
                        },
                        "media": [
                          {
                            "mimetype": "text",
                            "url": "https://example.com",
                            "signature": "text",
                            "dsa": "text"
                          }
                        ],
                        "images": [
                          {
                            "url": "https://example.com",
                            "size_type": "xs",
                            "width": "text",
                            "height": "text"
                          }
                        ]
                      },
                      "list": [
                        {
                          "descriptor": {
                            "name": "text",
                            "code": "text",
                            "short_desc": "text",
                            "long_desc": "text",
                            "additional_desc": {
                              "url": "text",
                              "content_type": "text/plain"
                            },
                            "media": [
                              {
                                "mimetype": "text",
                                "url": "https://example.com",
                                "signature": "text",
                                "dsa": "text"
                              }
                            ],
                            "images": [
                              {
                                "url": "https://example.com",
                                "size_type": "xs",
                                "width": "text",
                                "height": "text"
                              }
                            ]
                          },
                          "value": "text",
                          "display": true
                        }
                      ]
                    }
                  ]
                },
                "authorization": {
                  "type": "text",
                  "token": "text",
                  "valid_from": "2026-05-10T06:51:04.563Z",
                  "valid_to": "2026-05-10T06:51:04.563Z",
                  "status": "text"
                }
              }
            ],
            "path": "text",
            "tags": [
              {
                "display": true,
                "descriptor": {
                  "name": "text",
                  "code": "text",
                  "short_desc": "text",
                  "long_desc": "text",
                  "additional_desc": {
                    "url": "text",
                    "content_type": "text/plain"
                  },
                  "media": [
                    {
                      "mimetype": "text",
                      "url": "https://example.com",
                      "signature": "text",
                      "dsa": "text"
                    }
                  ],
                  "images": [
                    {
                      "url": "https://example.com",
                      "size_type": "xs",
                      "width": "text",
                      "height": "text"
                    }
                  ]
                },
                "list": [
                  {
                    "descriptor": {
                      "name": "text",
                      "code": "text",
                      "short_desc": "text",
                      "long_desc": "text",
                      "additional_desc": {
                        "url": "text",
                        "content_type": "text/plain"
                      },
                      "media": [
                        {
                          "mimetype": "text",
                          "url": "https://example.com",
                          "signature": "text",
                          "dsa": "text"
                        }
                      ],
                      "images": [
                        {
                          "url": "https://example.com",
                          "size_type": "xs",
                          "width": "text",
                          "height": "text"
                        }
                      ]
                    },
                    "value": "text",
                    "display": true
                  }
                ]
              }
            ]
          }
        ],
        "payments": [
          {
            "id": "text",
            "collected_by": null,
            "url": "https://example.com",
            "params": {
              "transaction_id": "text",
              "amount": "text",
              "currency": "text",
              "bank_code": "text",
              "bank_account_number": "text",
              "virtual_payment_address": "text",
              "source_bank_code": "text",
              "source_bank_account_number": "text",
              "source_virtual_payment_address": "text"
            },
            "type": "PRE-ORDER",
            "status": "PAID",
            "time": {
              "label": "text",
              "timestamp": "2026-05-10T06:51:04.563Z",
              "duration": "text",
              "range": {
                "start": "2026-05-10T06:51:04.563Z",
                "end": "2026-05-10T06:51:04.563Z"
              },
              "days": "text",
              "schedule": {
                "frequency": "text",
                "holidays": [
                  "2026-05-10T06:51:04.563Z"
                ],
                "times": [
                  "2026-05-10T06:51:04.563Z"
                ]
              }
            },
            "tags": [
              {
                "display": true,
                "descriptor": {
                  "name": "text",
                  "code": "text",
                  "short_desc": "text",
                  "long_desc": "text",
                  "additional_desc": {
                    "url": "text",
                    "content_type": "text/plain"
                  },
                  "media": [
                    {
                      "mimetype": "text",
                      "url": "https://example.com",
                      "signature": "text",
                      "dsa": "text"
                    }
                  ],
                  "images": [
                    {
                      "url": "https://example.com",
                      "size_type": "xs",
                      "width": "text",
                      "height": "text"
                    }
                  ]
                },
                "list": [
                  {
                    "descriptor": {
                      "name": "text",
                      "code": "text",
                      "short_desc": "text",
                      "long_desc": "text",
                      "additional_desc": {
                        "url": "text",
                        "content_type": "text/plain"
                      },
                      "media": [
                        {
                          "mimetype": "text",
                          "url": "https://example.com",
                          "signature": "text",
                          "dsa": "text"
                        }
                      ],
                      "images": [
                        {
                          "url": "https://example.com",
                          "size_type": "xs",
                          "width": "text",
                          "height": "text"
                        }
                      ]
                    },
                    "value": "text",
                    "display": true
                  }
                ]
              }
            ]
          }
        ],
        "locations": [
          {
            "id": "text",
            "descriptor": {
              "name": "text",
              "code": "text",
              "short_desc": "text",
              "long_desc": "text",
              "additional_desc": {
                "url": "text",
                "content_type": "text/plain"
              },
              "media": [
                {
                  "mimetype": "text",
                  "url": "https://example.com",
                  "signature": "text",
                  "dsa": "text"
                }
              ],
              "images": [
                {
                  "url": "https://example.com",
                  "size_type": "xs",
                  "width": "text",
                  "height": "text"
                }
              ]
            },
            "map_url": "https://example.com",
            "gps": "text",
            "address": "text",
            "city": {
              "name": "text",
              "code": "text"
            },
            "district": "text",
            "state": {
              "name": "text",
              "code": "text"
            },
            "country": {
              "name": "text",
              "code": "text"
            },
            "area_code": "text",
            "circle": {
              "gps": "text",
              "radius": {
                "type": "CONSTANT",
                "value": "text",
                "estimated_value": "text",
                "computed_value": "text",
                "range": {
                  "min": "text",
                  "max": "text"
                },
                "unit": "text"
              }
            },
            "polygon": "text",
            "3dspace": "text",
            "rating": "text"
          }
        ],
        "offers": [
          {
            "id": "text",
            "descriptor": {
              "name": "text",
              "code": "text",
              "short_desc": "text",
              "long_desc": "text",
              "additional_desc": {
                "url": "text",
                "content_type": "text/plain"
              },
              "media": [
                {
                  "mimetype": "text",
                  "url": "https://example.com",
                  "signature": "text",
                  "dsa": "text"
                }
              ],
              "images": [
                {
                  "url": "https://example.com",
                  "size_type": "xs",
                  "width": "text",
                  "height": "text"
                }
              ]
            },
            "location_ids": [
              "text"
            ],
            "category_ids": [
              "text"
            ],
            "item_ids": [
              "text"
            ],
            "time": {
              "label": "text",
              "timestamp": "2026-05-10T06:51:04.563Z",
              "duration": "text",
              "range": {
                "start": "2026-05-10T06:51:04.563Z",
                "end": "2026-05-10T06:51:04.563Z"
              },
              "days": "text",
              "schedule": {
                "frequency": "text",
                "holidays": [
                  "2026-05-10T06:51:04.563Z"
                ],
                "times": [
                  "2026-05-10T06:51:04.563Z"
                ]
              }
            },
            "tags": [
              {
                "display": true,
                "descriptor": {
                  "name": "text",
                  "code": "text",
                  "short_desc": "text",
                  "long_desc": "text",
                  "additional_desc": {
                    "url": "text",
                    "content_type": "text/plain"
                  },
                  "media": [
                    {
                      "mimetype": "text",
                      "url": "https://example.com",
                      "signature": "text",
                      "dsa": "text"
                    }
                  ],
                  "images": [
                    {
                      "url": "https://example.com",
                      "size_type": "xs",
                      "width": "text",
                      "height": "text"
                    }
                  ]
                },
                "list": [
                  {
                    "descriptor": {
                      "name": "text",
                      "code": "text",
                      "short_desc": "text",
                      "long_desc": "text",
                      "additional_desc": {
                        "url": "text",
                        "content_type": "text/plain"
                      },
                      "media": [
                        {
                          "mimetype": "text",
                          "url": "https://example.com",
                          "signature": "text",
                          "dsa": "text"
                        }
                      ],
                      "images": [
                        {
                          "url": "https://example.com",
                          "size_type": "xs",
                          "width": "text",
                          "height": "text"
                        }
                      ]
                    },
                    "value": "text",
                    "display": true
                  }
                ]
              }
            ]
          }
        ],
        "items": [
          {
            "id": "text",
            "parent_item_id": "text",
            "parent_item_quantity": {
              "allocated": {
                "count": 1,
                "measure": {
                  "type": "CONSTANT",
                  "value": "text",
                  "estimated_value": "text",
                  "computed_value": "text",
                  "range": {
                    "min": "text",
                    "max": "text"
                  },
                  "unit": "text"
                }
              },
              "available": {
                "count": 1,
                "measure": {
                  "type": "CONSTANT",
                  "value": "text",
                  "estimated_value": "text",
                  "computed_value": "text",
                  "range": {
                    "min": "text",
                    "max": "text"
                  },
                  "unit": "text"
                }
              },
              "maximum": {
                "count": 1,
                "measure": {
                  "type": "CONSTANT",
                  "value": "text",
                  "estimated_value": "text",
                  "computed_value": "text",
                  "range": {
                    "min": "text",
                    "max": "text"
                  },
                  "unit": "text"
                }
              },
              "minimum": {
                "count": 1,
                "measure": {
                  "type": "CONSTANT",
                  "value": "text",
                  "estimated_value": "text",
                  "computed_value": "text",
                  "range": {
                    "min": "text",
                    "max": "text"
                  },
                  "unit": "text"
                }
              },
              "selected": {
                "count": 1,
                "measure": {
                  "type": "CONSTANT",
                  "value": "text",
                  "estimated_value": "text",
                  "computed_value": "text",
                  "range": {
                    "min": "text",
                    "max": "text"
                  },
                  "unit": "text"
                }
              },
              "unitized": {
                "count": 1,
                "measure": {
                  "type": "CONSTANT",
                  "value": "text",
                  "estimated_value": "text",
                  "computed_value": "text",
                  "range": {
                    "min": "text",
                    "max": "text"
                  },
                  "unit": "text"
                }
              }
            },
            "descriptor": {
              "name": "text",
              "code": "text",
              "short_desc": "text",
              "long_desc": "text",
              "additional_desc": {
                "url": "text",
                "content_type": "text/plain"
              },
              "media": [
                {
                  "mimetype": "text",
                  "url": "https://example.com",
                  "signature": "text",
                  "dsa": "text"
                }
              ],
              "images": [
                {
                  "url": "https://example.com",
                  "size_type": "xs",
                  "width": "text",
                  "height": "text"
                }
              ]
            },
            "creator": {
              "descriptor": {
                "name": "text",
                "code": "text",
                "short_desc": "text",
                "long_desc": "text",
                "additional_desc": {
                  "url": "text",
                  "content_type": "text/plain"
                },
                "media": [
                  {
                    "mimetype": "text",
                    "url": "https://example.com",
                    "signature": "text",
                    "dsa": "text"
                  }
                ],
                "images": [
                  {
                    "url": "https://example.com",
                    "size_type": "xs",
                    "width": "text",
                    "height": "text"
                  }
                ]
              },
              "address": "text",
              "state": {
                "name": "text",
                "code": "text"
              },
              "city": {
                "name": "text",
                "code": "text"
              },
              "contact": {
                "phone": "text",
                "email": "text",
                "jcard": {}
              }
            },
            "price": {
              "currency": "text",
              "value": "text",
              "estimated_value": "text",
              "computed_value": "text",
              "listed_value": "text",
              "offered_value": "text",
              "minimum_value": "text",
              "maximum_value": "text"
            },
            "quantity": {
              "allocated": {
                "count": 1,
                "measure": {
                  "type": "CONSTANT",
                  "value": "text",
                  "estimated_value": "text",
                  "computed_value": "text",
                  "range": {
                    "min": "text",
                    "max": "text"
                  },
                  "unit": "text"
                }
              },
              "available": {
                "count": 1,
                "measure": {
                  "type": "CONSTANT",
                  "value": "text",
                  "estimated_value": "text",
                  "computed_value": "text",
                  "range": {
                    "min": "text",
                    "max": "text"
                  },
                  "unit": "text"
                }
              },
              "maximum": {
                "count": 1,
                "measure": {
                  "type": "CONSTANT",
                  "value": "text",
                  "estimated_value": "text",
                  "computed_value": "text",
                  "range": {
                    "min": "text",
                    "max": "text"
                  },
                  "unit": "text"
                }
              },
              "minimum": {
                "count": 1,
                "measure": {
                  "type": "CONSTANT",
                  "value": "text",
                  "estimated_value": "text",
                  "computed_value": "text",
                  "range": {
                    "min": "text",
                    "max": "text"
                  },
                  "unit": "text"
                }
              },
              "selected": {
                "count": 1,
                "measure": {
                  "type": "CONSTANT",
                  "value": "text",
                  "estimated_value": "text",
                  "computed_value": "text",
                  "range": {
                    "min": "text",
                    "max": "text"
                  },
                  "unit": "text"
                }
              },
              "unitized": {
                "count": 1,
                "measure": {
                  "type": "CONSTANT",
                  "value": "text",
                  "estimated_value": "text",
                  "computed_value": "text",
                  "range": {
                    "min": "text",
                    "max": "text"
                  },
                  "unit": "text"
                }
              }
            },
            "category_ids": [
              "text"
            ],
            "fulfillment_ids": [
              "text"
            ],
            "location_ids": [
              "text"
            ],
            "payment_ids": [
              "text"
            ],
            "add_ons": [
              {
                "id": "text",
                "descriptor": {
                  "name": "text",
                  "code": "text",
                  "short_desc": "text",
                  "long_desc": "text",
                  "additional_desc": {
                    "url": "text",
                    "content_type": "text/plain"
                  },
                  "media": [
                    {
                      "mimetype": "text",
                      "url": "https://example.com",
                      "signature": "text",
                      "dsa": "text"
                    }
                  ],
                  "images": [
                    {
                      "url": "https://example.com",
                      "size_type": "xs",
                      "width": "text",
                      "height": "text"
                    }
                  ]
                },
                "price": {
                  "currency": "text",
                  "value": "text",
                  "estimated_value": "text",
                  "computed_value": "text",
                  "listed_value": "text",
                  "offered_value": "text",
                  "minimum_value": "text",
                  "maximum_value": "text"
                }
              }
            ],
            "cancellation_terms": [
              {
                "fulfillment_state": {
                  "descriptor": {
                    "name": "text",
                    "code": "text",
                    "short_desc": "text",
                    "long_desc": "text",
                    "additional_desc": {
                      "url": "text",
                      "content_type": "text/plain"
                    },
                    "media": [
                      {
                        "mimetype": "text",
                        "url": "https://example.com",
                        "signature": "text",
                        "dsa": "text"
                      }
                    ],
                    "images": [
                      {
                        "url": "https://example.com",
                        "size_type": "xs",
                        "width": "text",
                        "height": "text"
                      }
                    ]
                  },
                  "updated_at": "2026-05-10T06:51:04.563Z",
                  "updated_by": "text"
                },
                "reason_required": true,
                "cancel_by": {
                  "label": "text",
                  "timestamp": "2026-05-10T06:51:04.563Z",
                  "duration": "text",
                  "range": {
                    "start": "2026-05-10T06:51:04.563Z",
                    "end": "2026-05-10T06:51:04.563Z"
                  },
                  "days": "text",
                  "schedule": {
                    "frequency": "text",
                    "holidays": [
                      "2026-05-10T06:51:04.563Z"
                    ],
                    "times": [
                      "2026-05-10T06:51:04.563Z"
                    ]
                  }
                },
                "cancellation_fee": {
                  "percentage": "text",
                  "amount": {
                    "currency": "text",
                    "value": "text",
                    "estimated_value": "text",
                    "computed_value": "text",
                    "listed_value": "text",
                    "offered_value": "text",
                    "minimum_value": "text",
                    "maximum_value": "text"
                  }
                },
                "xinput": {
                  "id": "text",
                  "head": {
                    "descriptor": {
                      "id": "text",
                      "url": "https://example.com",
                      "data": {
                        "ANY_ADDITIONAL_PROPERTY": "text"
                      },
                      "mime_type": "text/html",
                      "submission_id": "123e4567-e89b-12d3-a456-426614174000"
                    },
                    "index": {
                      "cur": 1,
                      "max": 1,
                      "min": 1
                    },
                    "headings": [
                      "text"
                    ]
                  },
                  "form": {
                    "id": "text",
                    "url": "https://example.com",
                    "data": {
                      "ANY_ADDITIONAL_PROPERTY": "text"
                    },
                    "mime_type": "text/html",
                    "submission_id": "123e4567-e89b-12d3-a456-426614174000"
                  },
                  "required": true
                },
                "external_ref": {
                  "mimetype": "text",
                  "url": "https://example.com",
                  "signature": "text",
                  "dsa": "text"
                }
              }
            ],
            "refund_terms": [
              {
                "fulfillment_state": {
                  "name": "text",
                  "code": "text"
                },
                "refund_eligible": true,
                "refund_within": {
                  "label": "text",
                  "timestamp": "2026-05-10T06:51:04.563Z",
                  "duration": "text",
                  "range": {
                    "start": "2026-05-10T06:51:04.563Z",
                    "end": "2026-05-10T06:51:04.563Z"
                  },
                  "days": "text",
                  "schedule": {
                    "frequency": "text",
                    "holidays": [
                      "2026-05-10T06:51:04.563Z"
                    ],
                    "times": [
                      "2026-05-10T06:51:04.563Z"
                    ]
                  }
                },
                "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": "2026-05-10T06:51:04.563Z",
                  "duration": "text",
                  "range": {
                    "start": "2026-05-10T06:51:04.563Z",
                    "end": "2026-05-10T06:51:04.563Z"
                  },
                  "days": "text",
                  "schedule": {
                    "frequency": "text",
                    "holidays": [
                      "2026-05-10T06:51:04.563Z"
                    ],
                    "times": [
                      "2026-05-10T06:51:04.563Z"
                    ]
                  }
                },
                "external_ref": {
                  "mimetype": "text",
                  "url": "https://example.com",
                  "signature": "text",
                  "dsa": "text"
                }
              }
            ],
            "return_terms": [
              {
                "fulfillment_state": {
                  "name": "text",
                  "code": "text"
                },
                "return_eligible": true,
                "return_time": {
                  "label": "text",
                  "timestamp": "2026-05-10T06:51:04.563Z",
                  "duration": "text",
                  "range": {
                    "start": "2026-05-10T06:51:04.563Z",
                    "end": "2026-05-10T06:51:04.563Z"
                  },
                  "days": "text",
                  "schedule": {
                    "frequency": "text",
                    "holidays": [
                      "2026-05-10T06:51:04.563Z"
                    ],
                    "times": [
                      "2026-05-10T06:51:04.563Z"
                    ]
                  }
                },
                "return_location": {
                  "id": "text",
                  "descriptor": {
                    "name": "text",
                    "code": "text",
                    "short_desc": "text",
                    "long_desc": "text",
                    "additional_desc": {
                      "url": "text",
                      "content_type": "text/plain"
                    },
                    "media": [
                      {
                        "mimetype": "text",
                        "url": "https://example.com",
                        "signature": "text",
                        "dsa": "text"
                      }
                    ],
                    "images": [
                      {
                        "url": "https://example.com",
                        "size_type": "xs",
                        "width": "text",
                        "height": "text"
                      }
                    ]
                  },
                  "map_url": "https://example.com",
                  "gps": "text",
                  "address": "text",
                  "city": {
                    "name": "text",
                    "code": "text"
                  },
                  "district": "text",
                  "state": {
                    "name": "text",
                    "code": "text"
                  },
                  "country": {
                    "name": "text",
                    "code": "text"
                  },
                  "area_code": "text",
                  "circle": {
                    "gps": "text",
                    "radius": {
                      "type": "CONSTANT",
                      "value": "text",
                      "estimated_value": "text",
                      "computed_value": "text",
                      "range": {
                        "min": "text",
                        "max": "text"
                      },
                      "unit": "text"
                    }
                  },
                  "polygon": "text",
                  "3dspace": "text",
                  "rating": "text"
                },
                "fulfillment_managed_by": "CONSUMER"
              }
            ],
            "xinput": {
              "id": "text",
              "head": {
                "descriptor": {
                  "id": "text",
                  "url": "https://example.com",
                  "data": {
                    "ANY_ADDITIONAL_PROPERTY": "text"
                  },
                  "mime_type": "text/html",
                  "submission_id": "123e4567-e89b-12d3-a456-426614174000"
                },
                "index": {
                  "cur": 1,
                  "max": 1,
                  "min": 1
                },
                "headings": [
                  "text"
                ]
              },
              "form": {
                "id": "text",
                "url": "https://example.com",
                "data": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "mime_type": "text/html",
                "submission_id": "123e4567-e89b-12d3-a456-426614174000"
              },
              "required": true
            },
            "time": {
              "label": "text",
              "timestamp": "2026-05-10T06:51:04.563Z",
              "duration": "text",
              "range": {
                "start": "2026-05-10T06:51:04.563Z",
                "end": "2026-05-10T06:51:04.563Z"
              },
              "days": "text",
              "schedule": {
                "frequency": "text",
                "holidays": [
                  "2026-05-10T06:51:04.563Z"
                ],
                "times": [
                  "2026-05-10T06:51:04.563Z"
                ]
              }
            },
            "rateable": true,
            "rating": "text",
            "matched": true,
            "related": true,
            "recommended": true,
            "ttl": "text",
            "tags": [
              {
                "display": true,
                "descriptor": {
                  "name": "text",
                  "code": "text",
                  "short_desc": "text",
                  "long_desc": "text",
                  "additional_desc": {
                    "url": "text",
                    "content_type": "text/plain"
                  },
                  "media": [
                    {
                      "mimetype": "text",
                      "url": "https://example.com",
                      "signature": "text",
                      "dsa": "text"
                    }
                  ],
                  "images": [
                    {
                      "url": "https://example.com",
                      "size_type": "xs",
                      "width": "text",
                      "height": "text"
                    }
                  ]
                },
                "list": [
                  {
                    "descriptor": {
                      "name": "text",
                      "code": "text",
                      "short_desc": "text",
                      "long_desc": "text",
                      "additional_desc": {
                        "url": "text",
                        "content_type": "text/plain"
                      },
                      "media": [
                        {
                          "mimetype": "text",
                          "url": "https://example.com",
                          "signature": "text",
                          "dsa": "text"
                        }
                      ],
                      "images": [
                        {
                          "url": "https://example.com",
                          "size_type": "xs",
                          "width": "text",
                          "height": "text"
                        }
                      ]
                    },
                    "value": "text",
                    "display": true
                  }
                ]
              }
            ]
          }
        ],
        "exp": "2026-05-10T06:51:04.563Z",
        "rateable": true,
        "ttl": 1,
        "tags": [
          {
            "display": true,
            "descriptor": {
              "name": "text",
              "code": "text",
              "short_desc": "text",
              "long_desc": "text",
              "additional_desc": {
                "url": "text",
                "content_type": "text/plain"
              },
              "media": [
                {
                  "mimetype": "text",
                  "url": "https://example.com",
                  "signature": "text",
                  "dsa": "text"
                }
              ],
              "images": [
                {
                  "url": "https://example.com",
                  "size_type": "xs",
                  "width": "text",
                  "height": "text"
                }
              ]
            },
            "list": [
              {
                "descriptor": {
                  "name": "text",
                  "code": "text",
                  "short_desc": "text",
                  "long_desc": "text",
                  "additional_desc": {
                    "url": "text",
                    "content_type": "text/plain"
                  },
                  "media": [
                    {
                      "mimetype": "text",
                      "url": "https://example.com",
                      "signature": "text",
                      "dsa": "text"
                    }
                  ],
                  "images": [
                    {
                      "url": "https://example.com",
                      "size_type": "xs",
                      "width": "text",
                      "height": "text"
                    }
                  ]
                },
                "value": "text",
                "display": true
              }
            ]
          }
        ]
      },
      "fulfillment": {
        "id": "text",
        "type": "text",
        "rateable": true,
        "rating": "text",
        "state": {
          "descriptor": {
            "name": "text",
            "code": "text",
            "short_desc": "text",
            "long_desc": "text",
            "additional_desc": {
              "url": "text",
              "content_type": "text/plain"
            },
            "media": [
              {
                "mimetype": "text",
                "url": "https://example.com",
                "signature": "text",
                "dsa": "text"
              }
            ],
            "images": [
              {
                "url": "https://example.com",
                "size_type": "xs",
                "width": "text",
                "height": "text"
              }
            ]
          },
          "updated_at": "2026-05-10T06:51:04.563Z",
          "updated_by": "text"
        },
        "tracking": false,
        "customer": {
          "person": {
            "id": "text",
            "url": "https://example.com",
            "name": "text",
            "image": {
              "url": "https://example.com",
              "size_type": "xs",
              "width": "text",
              "height": "text"
            },
            "age": "text",
            "dob": "2026-05-10",
            "gender": "text",
            "creds": [
              {
                "id": "text",
                "type": "VerifiableCredential",
                "url": "https://example.com"
              }
            ],
            "languages": [
              {
                "code": "text",
                "name": "text"
              }
            ],
            "skills": [
              {
                "code": "text",
                "name": "text"
              }
            ],
            "tags": [
              {
                "display": true,
                "descriptor": {
                  "name": "text",
                  "code": "text",
                  "short_desc": "text",
                  "long_desc": "text",
                  "additional_desc": {
                    "url": "text",
                    "content_type": "text/plain"
                  },
                  "media": [
                    {
                      "mimetype": "text",
                      "url": "https://example.com",
                      "signature": "text",
                      "dsa": "text"
                    }
                  ],
                  "images": [
                    {
                      "url": "https://example.com",
                      "size_type": "xs",
                      "width": "text",
                      "height": "text"
                    }
                  ]
                },
                "list": [
                  {
                    "descriptor": {
                      "name": "text",
                      "code": "text",
                      "short_desc": "text",
                      "long_desc": "text",
                      "additional_desc": {
                        "url": "text",
                        "content_type": "text/plain"
                      },
                      "media": [
                        {
                          "mimetype": "text",
                          "url": "https://example.com",
                          "signature": "text",
                          "dsa": "text"
                        }
                      ],
                      "images": [
                        {
                          "url": "https://example.com",
                          "size_type": "xs",
                          "width": "text",
                          "height": "text"
                        }
                      ]
                    },
                    "value": "text",
                    "display": true
                  }
                ]
              }
            ]
          },
          "contact": {
            "phone": "text",
            "email": "text",
            "jcard": {}
          }
        },
        "agent": {
          "id": "text",
          "person": {
            "id": "text",
            "url": "https://example.com",
            "name": "text",
            "image": {
              "url": "https://example.com",
              "size_type": "xs",
              "width": "text",
              "height": "text"
            },
            "age": "text",
            "dob": "2026-05-10",
            "gender": "text",
            "creds": [
              {
                "id": "text",
                "type": "VerifiableCredential",
                "url": "https://example.com"
              }
            ],
            "languages": [
              {
                "code": "text",
                "name": "text"
              }
            ],
            "skills": [
              {
                "code": "text",
                "name": "text"
              }
            ],
            "tags": [
              {
                "display": true,
                "descriptor": {
                  "name": "text",
                  "code": "text",
                  "short_desc": "text",
                  "long_desc": "text",
                  "additional_desc": {
                    "url": "text",
                    "content_type": "text/plain"
                  },
                  "media": [
                    {
                      "mimetype": "text",
                      "url": "https://example.com",
                      "signature": "text",
                      "dsa": "text"
                    }
                  ],
                  "images": [
                    {
                      "url": "https://example.com",
                      "size_type": "xs",
                      "width": "text",
                      "height": "text"
                    }
                  ]
                },
                "list": [
                  {
                    "descriptor": {
                      "name": "text",
                      "code": "text",
                      "short_desc": "text",
                      "long_desc": "text",
                      "additional_desc": {
                        "url": "text",
                        "content_type": "text/plain"
                      },
                      "media": [
                        {
                          "mimetype": "text",
                          "url": "https://example.com",
                          "signature": "text",
                          "dsa": "text"
                        }
                      ],
                      "images": [
                        {
                          "url": "https://example.com",
                          "size_type": "xs",
                          "width": "text",
                          "height": "text"
                        }
                      ]
                    },
                    "value": "text",
                    "display": true
                  }
                ]
              }
            ]
          },
          "contact": {
            "phone": "text",
            "email": "text",
            "jcard": {}
          },
          "organization": {
            "descriptor": {
              "name": "text",
              "code": "text",
              "short_desc": "text",
              "long_desc": "text",
              "additional_desc": {
                "url": "text",
                "content_type": "text/plain"
              },
              "media": [
                {
                  "mimetype": "text",
                  "url": "https://example.com",
                  "signature": "text",
                  "dsa": "text"
                }
              ],
              "images": [
                {
                  "url": "https://example.com",
                  "size_type": "xs",
                  "width": "text",
                  "height": "text"
                }
              ]
            },
            "address": "text",
            "state": {
              "name": "text",
              "code": "text"
            },
            "city": {
              "name": "text",
              "code": "text"
            },
            "contact": {
              "phone": "text",
              "email": "text",
              "jcard": {}
            }
          },
          "rating": "text"
        },
        "contact": {
          "phone": "text",
          "email": "text",
          "jcard": {}
        },
        "vehicle": {
          "category": "text",
          "capacity": 1,
          "make": "text",
          "model": "text",
          "size": "text",
          "variant": "text",
          "color": "text",
          "energy_type": "text",
          "registration": "text",
          "wheels_count": "text",
          "cargo_volumne": "text",
          "wheelchair_access": "text",
          "code": "text",
          "emission_standard": "text"
        },
        "stops": [
          {
            "id": "text",
            "parent_stop_id": "text",
            "location": {
              "id": "text",
              "descriptor": {
                "name": "text",
                "code": "text",
                "short_desc": "text",
                "long_desc": "text",
                "additional_desc": {
                  "url": "text",
                  "content_type": "text/plain"
                },
                "media": [
                  {
                    "mimetype": "text",
                    "url": "https://example.com",
                    "signature": "text",
                    "dsa": "text"
                  }
                ],
                "images": [
                  {
                    "url": "https://example.com",
                    "size_type": "xs",
                    "width": "text",
                    "height": "text"
                  }
                ]
              },
              "map_url": "https://example.com",
              "gps": "text",
              "address": "text",
              "city": {
                "name": "text",
                "code": "text"
              },
              "district": "text",
              "state": {
                "name": "text",
                "code": "text"
              },
              "country": {
                "name": "text",
                "code": "text"
              },
              "area_code": "text",
              "circle": {
                "gps": "text",
                "radius": {
                  "type": "CONSTANT",
                  "value": "text",
                  "estimated_value": "text",
                  "computed_value": "text",
                  "range": {
                    "min": "text",
                    "max": "text"
                  },
                  "unit": "text"
                }
              },
              "polygon": "text",
              "3dspace": "text",
              "rating": "text"
            },
            "type": "text",
            "time": {
              "label": "text",
              "timestamp": "2026-05-10T06:51:04.563Z",
              "duration": "text",
              "range": {
                "start": "2026-05-10T06:51:04.563Z",
                "end": "2026-05-10T06:51:04.563Z"
              },
              "days": "text",
              "schedule": {
                "frequency": "text",
                "holidays": [
                  "2026-05-10T06:51:04.563Z"
                ],
                "times": [
                  "2026-05-10T06:51:04.563Z"
                ]
              }
            },
            "instructions": {
              "name": "text",
              "code": "text",
              "short_desc": "text",
              "long_desc": "text",
              "additional_desc": {
                "url": "text",
                "content_type": "text/plain"
              },
              "media": [
                {
                  "mimetype": "text",
                  "url": "https://example.com",
                  "signature": "text",
                  "dsa": "text"
                }
              ],
              "images": [
                {
                  "url": "https://example.com",
                  "size_type": "xs",
                  "width": "text",
                  "height": "text"
                }
              ]
            },
            "contact": {
              "phone": "text",
              "email": "text",
              "jcard": {}
            },
            "person": {
              "id": "text",
              "url": "https://example.com",
              "name": "text",
              "image": {
                "url": "https://example.com",
                "size_type": "xs",
                "width": "text",
                "height": "text"
              },
              "age": "text",
              "dob": "2026-05-10",
              "gender": "text",
              "creds": [
                {
                  "id": "text",
                  "type": "VerifiableCredential",
                  "url": "https://example.com"
                }
              ],
              "languages": [
                {
                  "code": "text",
                  "name": "text"
                }
              ],
              "skills": [
                {
                  "code": "text",
                  "name": "text"
                }
              ],
              "tags": [
                {
                  "display": true,
                  "descriptor": {
                    "name": "text",
                    "code": "text",
                    "short_desc": "text",
                    "long_desc": "text",
                    "additional_desc": {
                      "url": "text",
                      "content_type": "text/plain"
                    },
                    "media": [
                      {
                        "mimetype": "text",
                        "url": "https://example.com",
                        "signature": "text",
                        "dsa": "text"
                      }
                    ],
                    "images": [
                      {
                        "url": "https://example.com",
                        "size_type": "xs",
                        "width": "text",
                        "height": "text"
                      }
                    ]
                  },
                  "list": [
                    {
                      "descriptor": {
                        "name": "text",
                        "code": "text",
                        "short_desc": "text",
                        "long_desc": "text",
                        "additional_desc": {
                          "url": "text",
                          "content_type": "text/plain"
                        },
                        "media": [
                          {
                            "mimetype": "text",
                            "url": "https://example.com",
                            "signature": "text",
                            "dsa": "text"
                          }
                        ],
                        "images": [
                          {
                            "url": "https://example.com",
                            "size_type": "xs",
                            "width": "text",
                            "height": "text"
                          }
                        ]
                      },
                      "value": "text",
                      "display": true
                    }
                  ]
                }
              ]
            },
            "authorization": {
              "type": "text",
              "token": "text",
              "valid_from": "2026-05-10T06:51:04.563Z",
              "valid_to": "2026-05-10T06:51:04.563Z",
              "status": "text"
            }
          }
        ],
        "path": "text",
        "tags": [
          {
            "display": true,
            "descriptor": {
              "name": "text",
              "code": "text",
              "short_desc": "text",
              "long_desc": "text",
              "additional_desc": {
                "url": "text",
                "content_type": "text/plain"
              },
              "media": [
                {
                  "mimetype": "text",
                  "url": "https://example.com",
                  "signature": "text",
                  "dsa": "text"
                }
              ],
              "images": [
                {
                  "url": "https://example.com",
                  "size_type": "xs",
                  "width": "text",
                  "height": "text"
                }
              ]
            },
            "list": [
              {
                "descriptor": {
                  "name": "text",
                  "code": "text",
                  "short_desc": "text",
                  "long_desc": "text",
                  "additional_desc": {
                    "url": "text",
                    "content_type": "text/plain"
                  },
                  "media": [
                    {
                      "mimetype": "text",
                      "url": "https://example.com",
                      "signature": "text",
                      "dsa": "text"
                    }
                  ],
                  "images": [
                    {
                      "url": "https://example.com",
                      "size_type": "xs",
                      "width": "text",
                      "height": "text"
                    }
                  ]
                },
                "value": "text",
                "display": true
              }
            ]
          }
        ]
      },
      "payment": {
        "id": "text",
        "collected_by": null,
        "url": "https://example.com",
        "params": {
          "transaction_id": "text",
          "amount": "text",
          "currency": "text",
          "bank_code": "text",
          "bank_account_number": "text",
          "virtual_payment_address": "text",
          "source_bank_code": "text",
          "source_bank_account_number": "text",
          "source_virtual_payment_address": "text"
        },
        "type": "PRE-ORDER",
        "status": "PAID",
        "time": {
          "label": "text",
          "timestamp": "2026-05-10T06:51:04.563Z",
          "duration": "text",
          "range": {
            "start": "2026-05-10T06:51:04.563Z",
            "end": "2026-05-10T06:51:04.563Z"
          },
          "days": "text",
          "schedule": {
            "frequency": "text",
            "holidays": [
              "2026-05-10T06:51:04.563Z"
            ],
            "times": [
              "2026-05-10T06:51:04.563Z"
            ]
          }
        },
        "tags": [
          {
            "display": true,
            "descriptor": {
              "name": "text",
              "code": "text",
              "short_desc": "text",
              "long_desc": "text",
              "additional_desc": {
                "url": "text",
                "content_type": "text/plain"
              },
              "media": [
                {
                  "mimetype": "text",
                  "url": "https://example.com",
                  "signature": "text",
                  "dsa": "text"
                }
              ],
              "images": [
                {
                  "url": "https://example.com",
                  "size_type": "xs",
                  "width": "text",
                  "height": "text"
                }
              ]
            },
            "list": [
              {
                "descriptor": {
                  "name": "text",
                  "code": "text",
                  "short_desc": "text",
                  "long_desc": "text",
                  "additional_desc": {
                    "url": "text",
                    "content_type": "text/plain"
                  },
                  "media": [
                    {
                      "mimetype": "text",
                      "url": "https://example.com",
                      "signature": "text",
                      "dsa": "text"
                    }
                  ],
                  "images": [
                    {
                      "url": "https://example.com",
                      "size_type": "xs",
                      "width": "text",
                      "height": "text"
                    }
                  ]
                },
                "value": "text",
                "display": true
              }
            ]
          }
        ]
      },
      "category": {
        "id": "text",
        "parent_category_id": "text",
        "descriptor": {
          "name": "text",
          "code": "text",
          "short_desc": "text",
          "long_desc": "text",
          "additional_desc": {
            "url": "text",
            "content_type": "text/plain"
          },
          "media": [
            {
              "mimetype": "text",
              "url": "https://example.com",
              "signature": "text",
              "dsa": "text"
            }
          ],
          "images": [
            {
              "url": "https://example.com",
              "size_type": "xs",
              "width": "text",
              "height": "text"
            }
          ]
        },
        "time": {
          "label": "text",
          "timestamp": "2026-05-10T06:51:04.563Z",
          "duration": "text",
          "range": {
            "start": "2026-05-10T06:51:04.563Z",
            "end": "2026-05-10T06:51:04.563Z"
          },
          "days": "text",
          "schedule": {
            "frequency": "text",
            "holidays": [
              "2026-05-10T06:51:04.563Z"
            ],
            "times": [
              "2026-05-10T06:51:04.563Z"
            ]
          }
        },
        "ttl": null,
        "tags": [
          {
            "display": true,
            "descriptor": {
              "name": "text",
              "code": "text",
              "short_desc": "text",
              "long_desc": "text",
              "additional_desc": {
                "url": "text",
                "content_type": "text/plain"
              },
              "media": [
                {
                  "mimetype": "text",
                  "url": "https://example.com",
                  "signature": "text",
                  "dsa": "text"
                }
              ],
              "images": [
                {
                  "url": "https://example.com",
                  "size_type": "xs",
                  "width": "text",
                  "height": "text"
                }
              ]
            },
            "list": [
              {
                "descriptor": {
                  "name": "text",
                  "code": "text",
                  "short_desc": "text",
                  "long_desc": "text",
                  "additional_desc": {
                    "url": "text",
                    "content_type": "text/plain"
                  },
                  "media": [
                    {
                      "mimetype": "text",
                      "url": "https://example.com",
                      "signature": "text",
                      "dsa": "text"
                    }
                  ],
                  "images": [
                    {
                      "url": "https://example.com",
                      "size_type": "xs",
                      "width": "text",
                      "height": "text"
                    }
                  ]
                },
                "value": "text",
                "display": true
              }
            ]
          }
        ]
      },
      "offer": {
        "id": "text",
        "descriptor": {
          "name": "text",
          "code": "text",
          "short_desc": "text",
          "long_desc": "text",
          "additional_desc": {
            "url": "text",
            "content_type": "text/plain"
          },
          "media": [
            {
              "mimetype": "text",
              "url": "https://example.com",
              "signature": "text",
              "dsa": "text"
            }
          ],
          "images": [
            {
              "url": "https://example.com",
              "size_type": "xs",
              "width": "text",
              "height": "text"
            }
          ]
        },
        "location_ids": [
          "text"
        ],
        "category_ids": [
          "text"
        ],
        "item_ids": [
          "text"
        ],
        "time": {
          "label": "text",
          "timestamp": "2026-05-10T06:51:04.563Z",
          "duration": "text",
          "range": {
            "start": "2026-05-10T06:51:04.563Z",
            "end": "2026-05-10T06:51:04.563Z"
          },
          "days": "text",
          "schedule": {
            "frequency": "text",
            "holidays": [
              "2026-05-10T06:51:04.563Z"
            ],
            "times": [
              "2026-05-10T06:51:04.563Z"
            ]
          }
        },
        "tags": [
          {
            "display": true,
            "descriptor": {
              "name": "text",
              "code": "text",
              "short_desc": "text",
              "long_desc": "text",
              "additional_desc": {
                "url": "text",
                "content_type": "text/plain"
              },
              "media": [
                {
                  "mimetype": "text",
                  "url": "https://example.com",
                  "signature": "text",
                  "dsa": "text"
                }
              ],
              "images": [
                {
                  "url": "https://example.com",
                  "size_type": "xs",
                  "width": "text",
                  "height": "text"
                }
              ]
            },
            "list": [
              {
                "descriptor": {
                  "name": "text",
                  "code": "text",
                  "short_desc": "text",
                  "long_desc": "text",
                  "additional_desc": {
                    "url": "text",
                    "content_type": "text/plain"
                  },
                  "media": [
                    {
                      "mimetype": "text",
                      "url": "https://example.com",
                      "signature": "text",
                      "dsa": "text"
                    }
                  ],
                  "images": [
                    {
                      "url": "https://example.com",
                      "size_type": "xs",
                      "width": "text",
                      "height": "text"
                    }
                  ]
                },
                "value": "text",
                "display": true
              }
            ]
          }
        ]
      },
      "item": {
        "id": "text",
        "parent_item_id": "text",
        "parent_item_quantity": {
          "allocated": {
            "count": 1,
            "measure": {
              "type": "CONSTANT",
              "value": "text",
              "estimated_value": "text",
              "computed_value": "text",
              "range": {
                "min": "text",
                "max": "text"
              },
              "unit": "text"
            }
          },
          "available": {
            "count": 1,
            "measure": {
              "type": "CONSTANT",
              "value": "text",
              "estimated_value": "text",
              "computed_value": "text",
              "range": {
                "min": "text",
                "max": "text"
              },
              "unit": "text"
            }
          },
          "maximum": {
            "count": 1,
            "measure": {
              "type": "CONSTANT",
              "value": "text",
              "estimated_value": "text",
              "computed_value": "text",
              "range": {
                "min": "text",
                "max": "text"
              },
              "unit": "text"
            }
          },
          "minimum": {
            "count": 1,
            "measure": {
              "type": "CONSTANT",
              "value": "text",
              "estimated_value": "text",
              "computed_value": "text",
              "range": {
                "min": "text",
                "max": "text"
              },
              "unit": "text"
            }
          },
          "selected": {
            "count": 1,
            "measure": {
              "type": "CONSTANT",
              "value": "text",
              "estimated_value": "text",
              "computed_value": "text",
              "range": {
                "min": "text",
                "max": "text"
              },
              "unit": "text"
            }
          },
          "unitized": {
            "count": 1,
            "measure": {
              "type": "CONSTANT",
              "value": "text",
              "estimated_value": "text",
              "computed_value": "text",
              "range": {
                "min": "text",
                "max": "text"
              },
              "unit": "text"
            }
          }
        },
        "descriptor": {
          "name": "text",
          "code": "text",
          "short_desc": "text",
          "long_desc": "text",
          "additional_desc": {
            "url": "text",
            "content_type": "text/plain"
          },
          "media": [
            {
              "mimetype": "text",
              "url": "https://example.com",
              "signature": "text",
              "dsa": "text"
            }
          ],
          "images": [
            {
              "url": "https://example.com",
              "size_type": "xs",
              "width": "text",
              "height": "text"
            }
          ]
        },
        "creator": {
          "descriptor": {
            "name": "text",
            "code": "text",
            "short_desc": "text",
            "long_desc": "text",
            "additional_desc": {
              "url": "text",
              "content_type": "text/plain"
            },
            "media": [
              {
                "mimetype": "text",
                "url": "https://example.com",
                "signature": "text",
                "dsa": "text"
              }
            ],
            "images": [
              {
                "url": "https://example.com",
                "size_type": "xs",
                "width": "text",
                "height": "text"
              }
            ]
          },
          "address": "text",
          "state": {
            "name": "text",
            "code": "text"
          },
          "city": {
            "name": "text",
            "code": "text"
          },
          "contact": {
            "phone": "text",
            "email": "text",
            "jcard": {}
          }
        },
        "price": {
          "currency": "text",
          "value": "text",
          "estimated_value": "text",
          "computed_value": "text",
          "listed_value": "text",
          "offered_value": "text",
          "minimum_value": "text",
          "maximum_value": "text"
        },
        "quantity": {
          "allocated": {
            "count": 1,
            "measure": {
              "type": "CONSTANT",
              "value": "text",
              "estimated_value": "text",
              "computed_value": "text",
              "range": {
                "min": "text",
                "max": "text"
              },
              "unit": "text"
            }
          },
          "available": {
            "count": 1,
            "measure": {
              "type": "CONSTANT",
              "value": "text",
              "estimated_value": "text",
              "computed_value": "text",
              "range": {
                "min": "text",
                "max": "text"
              },
              "unit": "text"
            }
          },
          "maximum": {
            "count": 1,
            "measure": {
              "type": "CONSTANT",
              "value": "text",
              "estimated_value": "text",
              "computed_value": "text",
              "range": {
                "min": "text",
                "max": "text"
              },
              "unit": "text"
            }
          },
          "minimum": {
            "count": 1,
            "measure": {
              "type": "CONSTANT",
              "value": "text",
              "estimated_value": "text",
              "computed_value": "text",
              "range": {
                "min": "text",
                "max": "text"
              },
              "unit": "text"
            }
          },
          "selected": {
            "count": 1,
            "measure": {
              "type": "CONSTANT",
              "value": "text",
              "estimated_value": "text",
              "computed_value": "text",
              "range": {
                "min": "text",
                "max": "text"
              },
              "unit": "text"
            }
          },
          "unitized": {
            "count": 1,
            "measure": {
              "type": "CONSTANT",
              "value": "text",
              "estimated_value": "text",
              "computed_value": "text",
              "range": {
                "min": "text",
                "max": "text"
              },
              "unit": "text"
            }
          }
        },
        "category_ids": [
          "text"
        ],
        "fulfillment_ids": [
          "text"
        ],
        "location_ids": [
          "text"
        ],
        "payment_ids": [
          "text"
        ],
        "add_ons": [
          {
            "id": "text",
            "descriptor": {
              "name": "text",
              "code": "text",
              "short_desc": "text",
              "long_desc": "text",
              "additional_desc": {
                "url": "text",
                "content_type": "text/plain"
              },
              "media": [
                {
                  "mimetype": "text",
                  "url": "https://example.com",
                  "signature": "text",
                  "dsa": "text"
                }
              ],
              "images": [
                {
                  "url": "https://example.com",
                  "size_type": "xs",
                  "width": "text",
                  "height": "text"
                }
              ]
            },
            "price": {
              "currency": "text",
              "value": "text",
              "estimated_value": "text",
              "computed_value": "text",
              "listed_value": "text",
              "offered_value": "text",
              "minimum_value": "text",
              "maximum_value": "text"
            }
          }
        ],
        "cancellation_terms": [
          {
            "fulfillment_state": {
              "descriptor": {
                "name": "text",
                "code": "text",
                "short_desc": "text",
                "long_desc": "text",
                "additional_desc": {
                  "url": "text",
                  "content_type": "text/plain"
                },
                "media": [
                  {
                    "mimetype": "text",
                    "url": "https://example.com",
                    "signature": "text",
                    "dsa": "text"
                  }
                ],
                "images": [
                  {
                    "url": "https://example.com",
                    "size_type": "xs",
                    "width": "text",
                    "height": "text"
                  }
                ]
              },
              "updated_at": "2026-05-10T06:51:04.563Z",
              "updated_by": "text"
            },
            "reason_required": true,
            "cancel_by": {
              "label": "text",
              "timestamp": "2026-05-10T06:51:04.563Z",
              "duration": "text",
              "range": {
                "start": "2026-05-10T06:51:04.563Z",
                "end": "2026-05-10T06:51:04.563Z"
              },
              "days": "text",
              "schedule": {
                "frequency": "text",
                "holidays": [
                  "2026-05-10T06:51:04.563Z"
                ],
                "times": [
                  "2026-05-10T06:51:04.563Z"
                ]
              }
            },
            "cancellation_fee": {
              "percentage": "text",
              "amount": {
                "currency": "text",
                "value": "text",
                "estimated_value": "text",
                "computed_value": "text",
                "listed_value": "text",
                "offered_value": "text",
                "minimum_value": "text",
                "maximum_value": "text"
              }
            },
            "xinput": {
              "id": "text",
              "head": {
                "descriptor": {
                  "id": "text",
                  "url": "https://example.com",
                  "data": {
                    "ANY_ADDITIONAL_PROPERTY": "text"
                  },
                  "mime_type": "text/html",
                  "submission_id": "123e4567-e89b-12d3-a456-426614174000"
                },
                "index": {
                  "cur": 1,
                  "max": 1,
                  "min": 1
                },
                "headings": [
                  "text"
                ]
              },
              "form": {
                "id": "text",
                "url": "https://example.com",
                "data": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "mime_type": "text/html",
                "submission_id": "123e4567-e89b-12d3-a456-426614174000"
              },
              "required": true
            },
            "external_ref": {
              "mimetype": "text",
              "url": "https://example.com",
              "signature": "text",
              "dsa": "text"
            }
          }
        ],
        "refund_terms": [
          {
            "fulfillment_state": {
              "name": "text",
              "code": "text"
            },
            "refund_eligible": true,
            "refund_within": {
              "label": "text",
              "timestamp": "2026-05-10T06:51:04.563Z",
              "duration": "text",
              "range": {
                "start": "2026-05-10T06:51:04.563Z",
                "end": "2026-05-10T06:51:04.563Z"
              },
              "days": "text",
              "schedule": {
                "frequency": "text",
                "holidays": [
                  "2026-05-10T06:51:04.563Z"
                ],
                "times": [
                  "2026-05-10T06:51:04.563Z"
                ]
              }
            },
            "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": "2026-05-10T06:51:04.563Z",
              "duration": "text",
              "range": {
                "start": "2026-05-10T06:51:04.563Z",
                "end": "2026-05-10T06:51:04.563Z"
              },
              "days": "text",
              "schedule": {
                "frequency": "text",
                "holidays": [
                  "2026-05-10T06:51:04.563Z"
                ],
                "times": [
                  "2026-05-10T06:51:04.563Z"
                ]
              }
            },
            "external_ref": {
              "mimetype": "text",
              "url": "https://example.com",
              "signature": "text",
              "dsa": "text"
            }
          }
        ],
        "return_terms": [
          {
            "fulfillment_state": {
              "name": "text",
              "code": "text"
            },
            "return_eligible": true,
            "return_time": {
              "label": "text",
              "timestamp": "2026-05-10T06:51:04.563Z",
              "duration": "text",
              "range": {
                "start": "2026-05-10T06:51:04.563Z",
                "end": "2026-05-10T06:51:04.563Z"
              },
              "days": "text",
              "schedule": {
                "frequency": "text",
                "holidays": [
                  "2026-05-10T06:51:04.563Z"
                ],
                "times": [
                  "2026-05-10T06:51:04.563Z"
                ]
              }
            },
            "return_location": {
              "id": "text",
              "descriptor": {
                "name": "text",
                "code": "text",
                "short_desc": "text",
                "long_desc": "text",
                "additional_desc": {
                  "url": "text",
                  "content_type": "text/plain"
                },
                "media": [
                  {
                    "mimetype": "text",
                    "url": "https://example.com",
                    "signature": "text",
                    "dsa": "text"
                  }
                ],
                "images": [
                  {
                    "url": "https://example.com",
                    "size_type": "xs",
                    "width": "text",
                    "height": "text"
                  }
                ]
              },
              "map_url": "https://example.com",
              "gps": "text",
              "address": "text",
              "city": {
                "name": "text",
                "code": "text"
              },
              "district": "text",
              "state": {
                "name": "text",
                "code": "text"
              },
              "country": {
                "name": "text",
                "code": "text"
              },
              "area_code": "text",
              "circle": {
                "gps": "text",
                "radius": {
                  "type": "CONSTANT",
                  "value": "text",
                  "estimated_value": "text",
                  "computed_value": "text",
                  "range": {
                    "min": "text",
                    "max": "text"
                  },
                  "unit": "text"
                }
              },
              "polygon": "text",
              "3dspace": "text",
              "rating": "text"
            },
            "fulfillment_managed_by": "CONSUMER"
          }
        ],
        "xinput": {
          "id": "text",
          "head": {
            "descriptor": {
              "id": "text",
              "url": "https://example.com",
              "data": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "mime_type": "text/html",
              "submission_id": "123e4567-e89b-12d3-a456-426614174000"
            },
            "index": {
              "cur": 1,
              "max": 1,
              "min": 1
            },
            "headings": [
              "text"
            ]
          },
          "form": {
            "id": "text",
            "url": "https://example.com",
            "data": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "mime_type": "text/html",
            "submission_id": "123e4567-e89b-12d3-a456-426614174000"
          },
          "required": true
        },
        "time": {
          "label": "text",
          "timestamp": "2026-05-10T06:51:04.563Z",
          "duration": "text",
          "range": {
            "start": "2026-05-10T06:51:04.563Z",
            "end": "2026-05-10T06:51:04.563Z"
          },
          "days": "text",
          "schedule": {
            "frequency": "text",
            "holidays": [
              "2026-05-10T06:51:04.563Z"
            ],
            "times": [
              "2026-05-10T06:51:04.563Z"
            ]
          }
        },
        "rateable": true,
        "rating": "text",
        "matched": true,
        "related": true,
        "recommended": true,
        "ttl": "text",
        "tags": [
          {
            "display": true,
            "descriptor": {
              "name": "text",
              "code": "text",
              "short_desc": "text",
              "long_desc": "text",
              "additional_desc": {
                "url": "text",
                "content_type": "text/plain"
              },
              "media": [
                {
                  "mimetype": "text",
                  "url": "https://example.com",
                  "signature": "text",
                  "dsa": "text"
                }
              ],
              "images": [
                {
                  "url": "https://example.com",
                  "size_type": "xs",
                  "width": "text",
                  "height": "text"
                }
              ]
            },
            "list": [
              {
                "descriptor": {
                  "name": "text",
                  "code": "text",
                  "short_desc": "text",
                  "long_desc": "text",
                  "additional_desc": {
                    "url": "text",
                    "content_type": "text/plain"
                  },
                  "media": [
                    {
                      "mimetype": "text",
                      "url": "https://example.com",
                      "signature": "text",
                      "dsa": "text"
                    }
                  ],
                  "images": [
                    {
                      "url": "https://example.com",
                      "size_type": "xs",
                      "width": "text",
                      "height": "text"
                    }
                  ]
                },
                "value": "text",
                "display": true
              }
            ]
          }
        ]
      },
      "tags": [
        {
          "display": true,
          "descriptor": {
            "name": "text",
            "code": "text",
            "short_desc": "text",
            "long_desc": "text",
            "additional_desc": {
              "url": "text",
              "content_type": "text/plain"
            },
            "media": [
              {
                "mimetype": "text",
                "url": "https://example.com",
                "signature": "text",
                "dsa": "text"
              }
            ],
            "images": [
              {
                "url": "https://example.com",
                "size_type": "xs",
                "width": "text",
                "height": "text"
              }
            ]
          },
          "list": [
            {
              "descriptor": {
                "name": "text",
                "code": "text",
                "short_desc": "text",
                "long_desc": "text",
                "additional_desc": {
                  "url": "text",
                  "content_type": "text/plain"
                },
                "media": [
                  {
                    "mimetype": "text",
                    "url": "https://example.com",
                    "signature": "text",
                    "dsa": "text"
                  }
                ],
                "images": [
                  {
                    "url": "https://example.com",
                    "size_type": "xs",
                    "width": "text",
                    "height": "text"
                  }
                ]
              },
              "value": "text",
              "display": true
            }
          ]
        }
      ]
    }
  }
}

default

Acknowledgement of message received after successful validation of schema and signature

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

get

Check availability of a resource in an inventory

Path parameters

resourcestring · enumRequired

Name of the resource

Possible values:

idone ofRequired

ID of the Resource

stringOptional

ID of the item.

Responses

default

Successful fetch of resources from the catalog

application/json

Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.

idstringOptional

ID of the item.

parent_item_idstringOptional

ID of the item.

category_idsstringOptional

ID of the category

fulfillment_idsstringOptional

Unique reference ID to the fulfillment of an order

location_idsstringOptional

payment_idsstringOptional

ID of the payment term that can be referred at an item or an order level in a catalog

rateablebooleanOptional

Whether this item can be rated

ratingstringOptional

Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.

matchedbooleanOptional

Whether this item is an exact match of the request

relatedbooleanOptional

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

recommendedbooleanOptional

Whether this item is a recommended item to a response

ttlstringOptional

Time to live in seconds for an instance of this schema

get

/inventory/checkAvailability/{resource}/{id}

HTTPcURLJavaScriptPython

GET /beckn/e-marketplace-bb/0.2/inventory/checkAvailability/{resource}/{id} HTTP/1.1
Host: virtserver.swaggerhub.com
Accept: */*

default

Successful fetch of resources from the catalog

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

post

Add Item to inventory

Body

application/json

Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.

idstringOptional

ID of the item.

parent_item_idstringOptional

ID of the item.

category_idsstringOptional

ID of the category

fulfillment_idsstringOptional

Unique reference ID to the fulfillment of an order

location_idsstringOptional

payment_idsstringOptional

ID of the payment term that can be referred at an item or an order level in a catalog

rateablebooleanOptional

Whether this item can be rated

ratingstringOptional

Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.

matchedbooleanOptional

Whether this item is an exact match of the request

relatedbooleanOptional

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

recommendedbooleanOptional

Whether this item is a recommended item to a response

ttlstringOptional

Time to live in seconds for an instance of this schema

Responses

default

Successful fetch of resources from the catalog

application/json

Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.

idstringOptional

ID of the item.

parent_item_idstringOptional

ID of the item.

category_idsstringOptional

ID of the category

fulfillment_idsstringOptional

Unique reference ID to the fulfillment of an order

location_idsstringOptional

payment_idsstringOptional

ID of the payment term that can be referred at an item or an order level in a catalog

rateablebooleanOptional

Whether this item can be rated

ratingstringOptional

Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.

matchedbooleanOptional

Whether this item is an exact match of the request

relatedbooleanOptional

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

recommendedbooleanOptional

Whether this item is a recommended item to a response

ttlstringOptional

Time to live in seconds for an instance of this schema

post

/inventory/item/add

HTTPcURLJavaScriptPython

POST /beckn/e-marketplace-bb/0.2/inventory/item/add HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 8971

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

default

Successful fetch of resources from the catalog

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

post

Remove Item from inventory

Body

application/json

Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.

idstringOptional

ID of the item.

parent_item_idstringOptional

ID of the item.

category_idsstringOptional

ID of the category

fulfillment_idsstringOptional

Unique reference ID to the fulfillment of an order

location_idsstringOptional

payment_idsstringOptional

ID of the payment term that can be referred at an item or an order level in a catalog

rateablebooleanOptional

Whether this item can be rated

ratingstringOptional

Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.

matchedbooleanOptional

Whether this item is an exact match of the request

relatedbooleanOptional

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

recommendedbooleanOptional

Whether this item is a recommended item to a response

ttlstringOptional

Time to live in seconds for an instance of this schema

Responses

default

Successful fetch of resources from the catalog

application/json

Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.

idstringOptional

ID of the item.

parent_item_idstringOptional

ID of the item.

category_idsstringOptional

ID of the category

fulfillment_idsstringOptional

Unique reference ID to the fulfillment of an order

location_idsstringOptional

payment_idsstringOptional

ID of the payment term that can be referred at an item or an order level in a catalog

rateablebooleanOptional

Whether this item can be rated

ratingstringOptional

Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.

matchedbooleanOptional

Whether this item is an exact match of the request

relatedbooleanOptional

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

recommendedbooleanOptional

Whether this item is a recommended item to a response

ttlstringOptional

Time to live in seconds for an instance of this schema

post

/inventory/item/remove

HTTPcURLJavaScriptPython

POST /beckn/e-marketplace-bb/0.2/inventory/item/remove HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 8971

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

default

Successful fetch of resources from the catalog

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

post

Block Item in inventory

Body

application/json

Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.

idstringOptional

ID of the item.

parent_item_idstringOptional

ID of the item.

category_idsstringOptional

ID of the category

fulfillment_idsstringOptional

Unique reference ID to the fulfillment of an order

location_idsstringOptional

payment_idsstringOptional

ID of the payment term that can be referred at an item or an order level in a catalog

rateablebooleanOptional

Whether this item can be rated

ratingstringOptional

Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.

matchedbooleanOptional

Whether this item is an exact match of the request

relatedbooleanOptional

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

recommendedbooleanOptional

Whether this item is a recommended item to a response

ttlstringOptional

Time to live in seconds for an instance of this schema

Responses

default

Successful fetch of resources from the catalog

application/json

Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.

idstringOptional

ID of the item.

parent_item_idstringOptional

ID of the item.

category_idsstringOptional

ID of the category

fulfillment_idsstringOptional

Unique reference ID to the fulfillment of an order

location_idsstringOptional

payment_idsstringOptional

ID of the payment term that can be referred at an item or an order level in a catalog

rateablebooleanOptional

Whether this item can be rated

ratingstringOptional

Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.

matchedbooleanOptional

Whether this item is an exact match of the request

relatedbooleanOptional

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

recommendedbooleanOptional

Whether this item is a recommended item to a response

ttlstringOptional

Time to live in seconds for an instance of this schema

post

/inventory/item/block

HTTPcURLJavaScriptPython

POST /beckn/e-marketplace-bb/0.2/inventory/item/block HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 8971

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

default

Successful fetch of resources from the catalog

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

post

Unblock addOn in inventory

Body

application/json

Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.

idstringOptional

ID of the item.

parent_item_idstringOptional

ID of the item.

category_idsstringOptional

ID of the category

fulfillment_idsstringOptional

Unique reference ID to the fulfillment of an order

location_idsstringOptional

payment_idsstringOptional

ID of the payment term that can be referred at an item or an order level in a catalog

rateablebooleanOptional

Whether this item can be rated

ratingstringOptional

Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.

matchedbooleanOptional

Whether this item is an exact match of the request

relatedbooleanOptional

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

recommendedbooleanOptional

Whether this item is a recommended item to a response

ttlstringOptional

Time to live in seconds for an instance of this schema

Responses

default

Successful fetch of resources from the catalog

application/json

Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.

idstringOptional

ID of the item.

parent_item_idstringOptional

ID of the item.

category_idsstringOptional

ID of the category

fulfillment_idsstringOptional

Unique reference ID to the fulfillment of an order

location_idsstringOptional

payment_idsstringOptional

ID of the payment term that can be referred at an item or an order level in a catalog

rateablebooleanOptional

Whether this item can be rated

ratingstringOptional

Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.

matchedbooleanOptional

Whether this item is an exact match of the request

relatedbooleanOptional

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

recommendedbooleanOptional

Whether this item is a recommended item to a response

ttlstringOptional

Time to live in seconds for an instance of this schema

post

/inventory/addOn/unblock

HTTPcURLJavaScriptPython

POST /beckn/e-marketplace-bb/0.2/inventory/addOn/unblock HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 8971

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

default

Successful fetch of resources from the catalog

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

post

Block add-on in inventory

Body

application/json

Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.

idstringOptional

ID of the item.

parent_item_idstringOptional

ID of the item.

category_idsstringOptional

ID of the category

fulfillment_idsstringOptional

Unique reference ID to the fulfillment of an order

location_idsstringOptional

payment_idsstringOptional

ID of the payment term that can be referred at an item or an order level in a catalog

rateablebooleanOptional

Whether this item can be rated

ratingstringOptional

Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.

matchedbooleanOptional

Whether this item is an exact match of the request

relatedbooleanOptional

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

recommendedbooleanOptional

Whether this item is a recommended item to a response

ttlstringOptional

Time to live in seconds for an instance of this schema

Responses

default

Successful fetch of resources from the catalog

application/json

Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.

idstringOptional

ID of the item.

parent_item_idstringOptional

ID of the item.

category_idsstringOptional

ID of the category

fulfillment_idsstringOptional

Unique reference ID to the fulfillment of an order

location_idsstringOptional

payment_idsstringOptional

ID of the payment term that can be referred at an item or an order level in a catalog

rateablebooleanOptional

Whether this item can be rated

ratingstringOptional

Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.

matchedbooleanOptional

Whether this item is an exact match of the request

relatedbooleanOptional

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

recommendedbooleanOptional

Whether this item is a recommended item to a response

ttlstringOptional

Time to live in seconds for an instance of this schema

post

/inventory/addOn/block

HTTPcURLJavaScriptPython

POST /beckn/e-marketplace-bb/0.2/inventory/addOn/block HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 8971

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

default

Successful fetch of resources from the catalog

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

post

Add Item to inventory

Body

application/json

Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.

idstringOptional

ID of the item.

parent_item_idstringOptional

ID of the item.

category_idsstringOptional

ID of the category

fulfillment_idsstringOptional

Unique reference ID to the fulfillment of an order

location_idsstringOptional

payment_idsstringOptional

ID of the payment term that can be referred at an item or an order level in a catalog

rateablebooleanOptional

Whether this item can be rated

ratingstringOptional

Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.

matchedbooleanOptional

Whether this item is an exact match of the request

relatedbooleanOptional

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

recommendedbooleanOptional

Whether this item is a recommended item to a response

ttlstringOptional

Time to live in seconds for an instance of this schema

Responses

default

Successful fetch of resources from the catalog

application/json

Describes a product or a service offered to the end consumer by the provider. In the mobility sector, it can represent a fare product like one way journey. In the logistics sector, it can represent the delivery service offering. In the retail domain it can represent a product like a grocery item.

idstringOptional

ID of the item.

parent_item_idstringOptional

ID of the item.

category_idsstringOptional

ID of the category

fulfillment_idsstringOptional

Unique reference ID to the fulfillment of an order

location_idsstringOptional

payment_idsstringOptional

ID of the payment term that can be referred at an item or an order level in a catalog

rateablebooleanOptional

Whether this item can be rated

ratingstringOptional

Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.

matchedbooleanOptional

Whether this item is an exact match of the request

relatedbooleanOptional

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

recommendedbooleanOptional

Whether this item is a recommended item to a response

ttlstringOptional

Time to live in seconds for an instance of this schema

post

/inventory/item/unblock

HTTPcURLJavaScriptPython

POST /beckn/e-marketplace-bb/0.2/inventory/item/unblock HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 8971

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

default

Successful fetch of resources from the catalog

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