Yoobic Products API
Products represent usually physical products and are organised by [`catalog`](#group-catalogs)### Fields| Field | Type | Required | Readonly | OrderBy | Description ||----------------------|:--------------:|:--------:|:--------:|:-------:|---------------------------||`product_id` | string | | x | | Unique id of the product ||`title` | string | x | | | The product title ||`price` | number | | | | The product price ||`reference` | string | x | | | The product reference (SKU) ||`image` | string | | | | The url to the image ||`short_desc` | string | | | | Short description of the product ||`description` | string | | | | Description of the product ||`catalog_id` | string | x | | x | Unique id of the catalog ||`catalog_title` | string | x | | | Title of the catalog ||`tags` | array | | | | Tags assigned to the product ||`manufacturer` | string | | | | The manufacturer name of the product ||`brand` | string | | | | The brand name of the product | |`category` | string | | | | The category name of the product | |`images` | array | | | | The images associated with this product | |`out_of_stock` | boolean | | | | Whether or not product is available | |`created_date` | date | | x | | Creation date ||`updated_date` | date | | x | x | Last update date ||`custom_fields` | object | | | | Dynamic properties (optional)|One of either fields is required:- catalog_id- catalog_title**Important:**- The `image` property should be a secured public URL (HTTPS).- For best experience in the app, its recommended that the `image` be a square picture.- `custom_fields` contains new attributes that can be used to describe more precisely a product. Custom fields provide a new way to customize your product data by allowing you to filter and select the relevant data in the application. You can create your own custom fields in the YOOBIC Web Application in order to enrich your product data. For the full list of supported field types see [campaigns](#group-campaigns-question-types)- `reference` is unique per catalog. If a product is uploaded with a combination of `catalog_id` or `catalog_title` and reference that already exist, then the corresponding product is updated.
Yoobic Products API is one of 41 APIs that Yoobic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Products. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a changelog.
This API exposes 5 operations across 5 paths, and defines 1 schema. It is described by OpenAPI 3.0.0.
Requests are made against a single base URL, https://.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Yoobic Products API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the authorizationCode flow.
Paths & Operations 5
Across 5 paths, the API surfaces 5 operations — 4 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Products represent usually physical products and are organised by [catalog](group-catalogs) Fields | Field | Type | Required | Readonly | OrderBy | Description | |----------------…
Schemas 1
The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Default_Header (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Yoobic 12
Other APIs Yoobic publishes across the network.