Params

Param name Description
organization_id
required

Filter products by organization

Validations:

  • Must be a number.

subscription_id
optional

Filter products by subscription

Validations:

  • Must be a number.

name
optional

Filter products by name

Validations:

  • String

enabled
optional

Filter products by enabled or disabled

Validations:

  • Must be one of: true, false, 1, 0

custom
optional

Filter products by custom

Validations:

  • Must be one of: true, false, 1, 0

include_available_content
optional

Whether to include available content attribute in results

Validations:

  • Must be one of: true, false, 1, 0

sync_plan_id
optional

Filter products by sync plan id

Validations:

  • Must be a number.

available_for
optional

Interpret specified object to return only Products that can be associated with specified object. Only ‘sync_plan’ is supported.

Validations:

  • String

search
optional

Search string

Validations:

  • String

page
optional

Page number, starting at 1

Validations:

  • Must be a number.

per_page
optional

Number of results per page to return

Validations:

  • Must be a number.

order
optional

Sort field and order, eg. ‘name DESC’

Validations:

  • String

full_result
optional

Whether or not to show all results

Validations:

  • Must be one of: true, false, 1, 0

sort
optional

Hash version of ‘order’ param

Validations:

  • Hash

sort[by]
optional

Field to sort the results on

Validations:

  • String

sort[order]
optional

How to order the sorted results (e.g. ASC for ascending)

Validations:

  • String