Collections
Create a Collection
post/v3/collections
Request body
collectionNamestring required
Unique name/path for the collection. Supports dot notation for hierarchical paths.
- Only letters (a-z, A-Z), digits (0-9), underscores (_), and dots (.) are allowed
- Each segment (between dots) must start with a letter or underscore (not a digit)
- Segments cannot consist only of digits
- Each segment must be 1-256 characters
- No leading, trailing, or consecutive dots
- Invalid names are rejected with a 400 Bad Request error
Valid Examples:
- 'product_catalog'
- 'orders.line_items.sku'
- 'customer_data'
- 'price_v2'
Invalid Examples:
- 'product-catalog' (contains hyphen)
- '123items' (starts with digit)
- 'items..data' (consecutive dots)
- 'order#123' (contains invalid character #)
Response
The request has succeeded.
collectionIDstring required
Unique identifier for the collection
collectionNamestring required
The collection name/path. Only letters, digits, underscores, and dots are allowed.
itemCountinteger required
Number of items in the collection
pageinteger
Current page number
limitinteger
Number of items per page
totalPagesinteger
Total number of pages
createdAtstring date-time required
When the collection was created
updatedAtstring date-time
When the collection was last updated