Schema
Tag
Defines a tag that can be associated with other entities in a merchant's catalog.
Overview
Properties
uuid
string
Required
The tag's unique identifier.
Format
uuid
Read only
Yes
model_type
enum
Required
Read only
Yes
Allowed values
tagname
string
Required
The tag's name.
Example
Drinks
Min length
1
Max length
255
colour
string
Required
The tag's colour.
Example
#F0F0F0
Pattern
^#([a-fA-F\d]{6}|[a-fA-F\d]{3})\b$
Min length
4
Max length
7
created_at
string
Required
The date-time that the tag was created.
Format
date-time
Read only
Yes
Used by
Raw YAML
Download source
title: Tag
x-tags:
- Catalog
type: object
description: Defines a tag that can be associated with other entities in a merchant's catalog.
properties:
uuid:
type: string
format: uuid
description: The tag's unique identifier.
readOnly: true
model_type:
enum:
- tag
readOnly: true
name:
type: string
example: Drinks
description: The tag's name.
minLength: 1
maxLength: 255
colour:
type: string
example: '#F0F0F0'
pattern: '^#([a-fA-F\d]{6}|[a-fA-F\d]{3})\b$'
description: The tag's colour.
minLength: 4
maxLength: 7
created_at:
type: string
format: date-time
description: The date-time that the tag was created.
readOnly: true
required:
- uuid
- model_type
- name
- colour
- created_at