Sign in

v5

latestOpenAPI 3.0.02026-08-017841,2603.2 MB
commerce
collection

List all collections

get/commerce/{connection_id}/collection

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

typestring
parent_idstring

The parent ID to filter by

saleschannel_idstring

The saleschannel ID to filter by (reference to CommerceSaleschannel)

org_idstring

The org ID to filter by (reference to AccountingOrganization)

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time
updated_atstring date-time
namestring required
public_namestring
descriptionstring
public_descriptionstring
is_visibleboolean
is_activeboolean
is_featuredboolean
tagsstring[]
type'COLLECTION' | 'SAVED_SEARCH' | 'CATEGORY'
parent_idstring
rawobject