# Yoobic Inventory API **Canonical:** https://apis.io/apis/yoobic/yoobic-inventory-api/ **Provider:** Yoobic — https://apis.io/providers/yoobic/ **Base URL:** https://api.yoobic.com/public/api **Documentation:** https://docs.yoobic.com/api.html Yoobic Inventory API is one of 41 APIs that [Yoobic](https://apis.io/providers/yoobic/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Inventory. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a changelog. An Inventory is a custom data structure to manage and use data in a similar way as in a spreadsheet or database directly from the YOOBIC Platform. Each inventory has a defined structure that rely on the same fields as in a YOOBIC campaign. ### Fields | Field | Type | Required | Readonly | OrderBy | Description | |----------------------|:--------------:|:--------:|:--------:|:-------:|---------------------------| |`inventory_id` | string | x | x | | Unique id of the inventory | |`description` | string | | x | | The inventory description | |`name` | string | | x | | The inventory name | |`title` | string | | x | | The inventory title | |`group_ids` | array | | x | | Group ids that can see this inventory | |`page_titles` | array | | x | | An ordered list of page titles i.e. first title is the first page title etc. | |`questions` | array | | x | | The inventory's questions | |`created_date` | date | | x | | Creation date | |`updated_date` | date | | x | x | Last update date | The `questions` field is defined as an array of: | Field | Type | Description | |----------------------|----------------|---------------------------| |`question_id` | string | Unique id of the question | |`question_type` | string | The type of the question. Supported types: `text`, `textarea`, `toggle`, `checkbox`, `information`, `todo`, `photo`, `multiphotos`, `selectbuttons`, `select`, `selectmulti`, `address`, `date`, `number`, `starrating`, `image`. | |`question` | string | The title of the question | |`question_description`| string | The description of the question | |`mandatory` | boolean | If `true`, the question has to be answered. Defaults to `false` | |`page_number` | number | The number of the page the question appears in | |`question_number` | number | The number of the question | |`hide_mobile` | boolean | Hide the question on mobile devices. Defaults to `false`. | |`question_attributes` | object | Question attributes for specific question types.| The `question_attributes` field is defined as an object with the following fields: | Field | Type | Description | |----------------------|----------------|---------------------------| |`max_photos` | number | Maximum of allowed photos to upload. Applies only to questions of type `multiphotos`. | |`values` | array | Values to be displayed as options to choose from in the question. Applies only to questions of type `selectbuttons`, `select`, `selectmulti`. | |`min` | number | If present, value must be above or including it. Applies only to questions of type `number`. | |`max` | number | If present, value must be below or including it. Applies only to questions of type `number`, `starrating`. | #### Question Types **Important** Below is a list of the supported types and their value types: | question_type | Type | Description | |---------------|:--------------:|-------------| | address | string | | | date | string | | | information | string | | | select | string | Single value chosen from the `values` defined in `question_attributes` | | textarea | string | | | text | string | | | photo | URL | A valid image URL | | multiphotos | array of URLs | Valid image URLs and up to `max_photos` defined in `question_attributes` | | selectbuttons | array | Multiple values chosen from the `values` defined in `question_attributes` | | selectmulti | array | Multiple values chosen from the `values` defined in `question_attributes` | | number | number | Might have min, max borders as defined in `question_attributes` | | starrating | number | Might have max border as defined in `question_attributes`. No negatives allowed. | | checkbox | boolean | | | toggle | boolean | | | image | | This is a readonly property (informative) which does not have a value. | **Important** - If `page_titles` does not have a title for a given page then a default will be given - So i.e. if the values are - ```json [ "first chapter", "second chapter" ] ``` and there are three pages in total, then the title for the third page will be `Page 3`. - To filter on `live` campaigns only you should filter accordingly: ```json { "active": true, "archived": { "neq": true } } ``` ## Machine-readable artifacts (11) - **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/openapi/yoobic-inventory-api-openapi.yml - **Documentation** — https://docs.yoobic.com/api.html - **APIReference** — https://docs.yoobic.com/api.html - **Postman** — https://assets.yoobic.com/raw/upload/v1767016464/3c85c240-dd03-4981-9814-bc6e5e861fa0.zip - **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/errors/yoobic-problem-types.yml - **Conventions** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/conventions/yoobic-conventions.yml - **ChangeLog** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/changelog/yoobic-changelog.yml - **Lifecycle** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/lifecycle/yoobic-lifecycle.yml - **Conformance** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/conformance/yoobic-conformance.yml - **Sandbox** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/sandbox/yoobic-sandbox.yml - **Webhooks** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/asyncapi/yoobic-webhooks.yml ## Other Yoobic APIs (12) - [Yoobic Answers API](https://apis.io/apis/yoobic/yoobic-answers-api/) - [Yoobic Badges API](https://apis.io/apis/yoobic/yoobic-badges-api/) - [Yoobic Bot Messages API](https://apis.io/apis/yoobic/yoobic-bot-messages-api/) - [Yoobic Bots API](https://apis.io/apis/yoobic/yoobic-bots-api/) - [Yoobic Business KPIs data - salesdata API](https://apis.io/apis/yoobic/yoobic-business-kpis-data-salesdata-api/) - [Yoobic Campaigns API](https://apis.io/apis/yoobic/yoobic-campaigns-api/) - [Yoobic Catalogs API](https://apis.io/apis/yoobic/yoobic-catalogs-api/) - [Yoobic Chats API](https://apis.io/apis/yoobic/yoobic-chats-api/) - [Yoobic Comments API](https://apis.io/apis/yoobic/yoobic-comments-api/) - [Yoobic Communities API](https://apis.io/apis/yoobic/yoobic-communities-api/) - [Yoobic Community Posts API](https://apis.io/apis/yoobic/yoobic-community-posts-api/) - [Yoobic Competencies API](https://apis.io/apis/yoobic/yoobic-competencies-api/) ## Tags Inventory --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/yoobic/yoobic-inventory-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/yoobic/.