Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Yoobic Store Types API

Stores always belong to specific Store Type. Store Types determine which stores users can potentially see. They will be linked to one or several user groups. Store types are used to have a better view of where the stores are (regions), or what type they belong to (business unit). Stores types are handy in the application when publishing campaigns to multiple stores. ### Fields| Field | Type | Required | Readonly | OrderBy | Description ||-----------------------------|:--------:|:--------:|:--------:|:-------:|-----------------------------||`store_type_id` | string | | x | | Unique id of the store type ||`name` | string | x | | x | Name of the store type ||`group_ids` | array | x | | | Group ids that can see this store type ||`user_ids` | array | | | | User ids that can see this store type ||`created_date` | date | | x | | Created Date||`updated_date` | date | | x | x | Updated Date|### TipTo summarize remember that stores always belong to specific store type. For example, all stores in the UK might belong to the type "UK Stores". Store Types must be created before importing or creating stores.

Yoobic Store Types API is one of 41 APIs that Yoobic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Store Types. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a changelog.

This API exposes 8 operations across 6 paths, and defines 1 schema. It is described by OpenAPI 3.0.0.

Requests are made against a single base URL, https:///.

8 operations 6 paths 1 schemas 1 DELETE4 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
Base URL
https://api.yoobic.com/public/api
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Yoobic Store Types API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow.

Paths & Operations 8

Across 6 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Store Types 8

Stores always belong to specific Store Type. Store Types determine which stores users can potentially see. They will be linked to one or several user groups. Store types are used…

GET
/public/api/store-types/{id}
Get
Get 1 param → 200
DELETE
/public/api/store-types/{id}
Delete
Delete → 204
PATCH
/public/api/store-types/{id}
Partial Update
Partial Update 1 param body → 200
GET
/public/api/store-types?filter={filter}
Get all
Get all 2 params body → 200
GET
/public/api/store-types/count?where={where}
Count
Count 2 params body → 200
POST
/public/api/store-types
Create
Create 1 param body → 200
GET
/public/api/store-types/export?{filter}&type={type}
Export
Export 3 params body → 200
POST
/public/api/store-types/import?type={type}
Import
Import 2 params body → 200

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.

Default_Header
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yoobic-store-types-api-openapi.yml Raw ↑

Other APIs Yoobic publishes across the network.

Yoobic Answers API
Yoobic Badges API
Yoobic Bot Messages API
Yoobic Bots API
Yoobic Business KPIs data - salesdata API
Yoobic Campaigns API
Yoobic Catalogs API
Yoobic Chats API
Yoobic Comments API
Yoobic Communities API
Yoobic Community Posts API
Yoobic Competencies API