Unified.to · Schema

CommerceCollection

A collection of items/products/services

IntegrationsUnified API

Properties

Name Type Description
id string
created_at string
updated_at string
name string
public_name string
description string
public_description string
media object
is_visible boolean
is_active boolean
is_featured boolean
tags object
type string
parent_id string
metadata object
item_metadata object
raw object
View JSON Schema on GitHub

JSON Schema

unified-to-commerce-collection-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/unified-to/refs/heads/main/json-schema/unified-to-commerce-collection-schema.json",
  "title": "CommerceCollection",
  "description": "A collection of items/products/services",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "name": {
      "type": "string"
    },
    "public_name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "public_description": {
      "type": "string"
    },
    "media": {
      "$ref": "#/components/schemas/property_CommerceCollection_media"
    },
    "is_visible": {
      "type": "boolean"
    },
    "is_active": {
      "type": "boolean"
    },
    "is_featured": {
      "type": "boolean"
    },
    "tags": {
      "$ref": "#/components/schemas/property_CommerceCollection_tags"
    },
    "type": {
      "type": "string",
      "enum": [
        "COLLECTION",
        "SAVED_SEARCH",
        "CATEGORY"
      ],
      "x-speakeasy-unknown-values": "allow"
    },
    "parent_id": {
      "type": "string"
    },
    "metadata": {
      "$ref": "#/components/schemas/property_CommerceCollection_metadata"
    },
    "item_metadata": {
      "$ref": "#/components/schemas/property_CommerceCollection_item_metadata"
    },
    "raw": {
      "type": "object",
      "additionalProperties": true
    }
  },
  "required": [
    "name"
  ]
}