POST
/
v1
/
products
/
{product}

Authorizations

Authorization
string
headerrequired

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

Headers

Idempotency-Key
string

Chave única de idempotência para evitar duplicação de requisições.

Path Parameters

product
string
required

ID do produto

Query Parameters

expand
string

Expande as referências.

Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.

fields
string[]

Uma lista separada por vírgulas de atributos a serem incluídos na resposta. Isso pode ser usado para solicitar campos que normalmente não são retornados em uma resposta padrão.

Esteja ciente de que especificar este parâmetro terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Body

application/json

Este objeto representa um produto.

slug
string

Deve ser uma string sem espaços ou caracteres especiais. É utilizada para agrupar produtos do mesmo tipo.

status
enum<string>
default: active

Status do produto. Se inativo, não será exibido no Portal do Cliente.

Available options:
active,
inactive
name
string

Nome do produto que será exibido aos usuários

description
string

Pequena descrição sobre o produto. Pode ser exibido na página inicial do Portal do Cliente.

settings
object
metadata
object

Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.

Response

200 - application/json

Este objeto representa um produto.

id
string

Identificador exclusivo para o objeto.

slug
string

Deve ser uma string sem espaços ou caracteres especiais. É utilizada para agrupar produtos do mesmo tipo.

status
enum<string>
default: active

Status do produto. Se inativo, não será exibido no Portal do Cliente.

Available options:
active,
inactive
name
string

Nome do produto que será exibido aos usuários

description
string

Pequena descrição sobre o produto. Pode ser exibido na página inicial do Portal do Cliente.

settings
object
metadata
object

Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.

createdAt
string

Data de criação do objeto

updatedAt
string

Data de alteração do objeto

deleted
boolean
default: false

Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.