Skip to navigation
StorefrontCatalogueCollections

Get Collection

View as Markdown

Returns a collection with one page of its products. The handle all returns every published product. The page details sit inside data.

Keys: public key or secret key.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

identitystring
The identity for the active workspace.

Path parameters

handlestringRequired
The record's handle.

Headers

channelstringRequired

Query parameters

qstringOptional
Search text, limited to the collection.
sort_byenumOptional
Order of the results. Newest first when omitted.
Allowed values:
countrystringOptional2-3 characters

Market to price for, as a two- or three-letter country code (NG or NGA). Defaults to the channel’s default country.

pageintegerOptional>=1Defaults to 1

Page number, starting at 1. Ignored when last_id and keyset are sent.

sizeintegerOptional1-50Defaults to 20
Records per page. Defaults to 20, capped at 50.
last_idstringOptionalformat: "uuid"

The last_id from the previous response. Send it with keyset to get the next page. Omit both for the first page.

keysetstringOptional

The keyset from the previous response. Send it with last_id. Copy it as it is; don’t build or change it.

Response

Successfully fetched collection
statusboolean

Always true on success.

messagestring

Human-readable outcome.

dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
404
Not Found Error