The Collection Object
Paginated Response
The Collections endpoint returns a paginated response with the following envelope:For details on how to paginate through large result sets, see Request & Response Standards → Pagination.
Key Concepts & Business Rules
Collections are read-only via the API
Collections available to your account are curated by Snappy or created via the Snappy Dashboard. You cannot create or modify Collections through the API - only retrieve them.Collection types
Thetypes field indicates the category of items within the Collection. This can be useful for filtering Collections when configuring a Campaign for a specific use case - for example, selecting only swag Collections for a branded merchandise campaign.
Assigning a Collection to a Campaign
To use a Collection in a gifting flow, assign itsid to a Campaign. Recipients will then browse and select from that Collection when they claim their gift.
A Campaign can be assigned either a Collection or a specific Product - not both. See Campaigns for details.
How to Work with Collections
Retrieving Collections Search for and retrieve a list of available Collections based on your specified criteria:- Budget range
- Supported countries
- Collection types (e.g.
gifts,swag)
Swag collections can only be retrieved by specifying the
accountId in the request.- Budget range
- Supported countries
- Budget range
- Supported countries