Parâmentros

Nome parâmetro Descrição
organization_id
requerido

Filtrar produtos por organização

Validations:

  • number.

subscription_id
opcional

Filtrar produtos por subscrição

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

name
opcional

Filtrar produtos por nome

Validations:

  • String

enabled
opcional

Filtrar produtos por ativado ou desativado

Validations:

  • boolean

custom
opcional

Filtrar produtos por padronizados

Validations:

  • boolean

include_available_content
opcional

Se deve incluir ou não atributos de conteúdo disponível nos resultados

Validations:

  • boolean

sync_plan_id
opcional

Filtrar produtos por id de plano de sincronização

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

available_for
opcional

Interpretar objetos especificados para retornar somente produtos que podem ser associados com os objetos especificados. Somente 'sync_plan' possui suporte.

Validations:

  • String

search
opcional

Buscar faixa

Validations:

  • String

page
opcional

Número de página, iniciando em 1

Validations:

  • number.

per_page
opcional

Número de resultados por página para retornar

Validations:

  • number.

order
opcional

Classificar campo e ordem, ex. 'name DESC'

Validations:

  • String

full_results
opcional

Se deve ou não exibir todos os resultados

Validations:

  • boolean

sort
opcional

Versão Hash de param de “ordem”

Validations:

  • Hash

sort[by]
opcional

Campo para classificar os resultados

Validations:

  • String

sort[order]
opcional

Como encomendar os resultados classificados (por exemplo ASC para ascendente)

Validations:

  • String