Collection API Reference

Collection resource object:

{
	"type": "collections",
	"id": "(string)",
	"attributes": {
		"title": "string",
		"handle": "string",
		"description": "string",
		"content": "string",
		"visibility": "string|in:public,private,with-link",
		"product_count": Integer,
		"sorting": Integer,
		"is_auto": Boolean,
		"query": Array,
		"created_at": "string|datetime",
		"updated_at": "string|datetime"
	},
	"relationships": {
		"image": {
			"data": Object (Image Resource) | null
		}
	}
}

Related resources: Image, Product

Writable fields

Field name	Creating	Updating
title	required|max:255	max:255
handle	max:255	max:255
description	max:255	max:255
content	max:60000	max:60000
visibility	string|in:public,private,with-link	string|in:public,private,with-link
is_auto	Boolean	Boolean
sorting	Integer|min:0	max:100000
query	array (query selection data)	array (query selection data)

Writable relationships

Relationship name	Relationship resource type	Type	Creating	Updating
image	images	To-one	Yes	Yes

Sortable

Field name
sorting
created_at
updated_at