Sign in

v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-29208421.4 MB
Collection

Create collection

Creates a new collection.

⚠️ This endpoint is compatible with collections configured through the Legacy CMS Portal.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

ProductCategoryResource
CatalogCollectionWrite Collections

There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see Authentication overview.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

post/api/catalog/pvt/collection

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Request body

Namestring required

Collection's name.

Descriptionstring required

Collection's description for internal use, with the collection's details. It will not be used for search engines.

Searchableboolean required

Option making the collection searchable in the store.

Highlightboolean required

Option if you want the collection to highlight specific products using a tag.

DateFromstring required

Collection start date and time. If a future date and time are set, the collection will have a scheduled status.

DateTostring required

Collection end date and time.

Example request

{
  "Name": "Halloween costumes",
  "Description": "HomeHalloween",
  "DateFrom": "2025-11-26T15:23:00",
  "DateTo": "2069-11-26T15:23:00"
}

Response

OK

Idinteger

Collection's ID.

Namestring

Collection's name.

Descriptionstring

Collection's description for internal use, with the collection's details. It will not be used for search engines.

Searchableboolean

Option making the collection searchable in the store.

Highlightboolean

Option if you want the collection to highlight specific products using a tag.

DateFromstring

Collection start date and time. If a future date and time are set, the collection will have a scheduled status.

DateTostring

Collection end date and time.

TotalProductsinteger

Number of products contained in the collection.

Typestring

Type of the collection.