Skip to content

Criar item de catálogo

post

/catalogs/{catalog_name}/items/{item_id}

Use esse endpoint para criar um item em seu catálogo.

Pré-requisitos

Para usar esse endpoint, você precisará de uma chave de API com a permissão catalogs.create_item.

Limite de taxa

Parâmetros da jornada

Parâmetro Obrigatória Tipo de dados Descrição
catalog_name Obrigatória String Nome do catálogo.
item_id Obrigatória String A ID do item do catálogo.

Parâmetros de solicitação

Parâmetro Obrigatória Tipo de dados Descrição
items Obrigatória Vetor Um vetor que contém objetos de item. Os objetos de item devem conter todos os campos do catálogo, exceto o campo id. Somente um objeto de item é permitido por solicitação.

Exemplo de solicitação

Resposta

Há três respostas de código de status para esse endpoint: 201, 400 e 404.

Exemplo de resposta bem-sucedida

O código de status 201 poderia retornar o seguinte corpo de resposta.

Exemplo de resposta de erro

O código de status 400 poderia retornar o seguinte corpo de resposta. Consulte Solução de problemas para obter mais informações sobre os erros que você pode encontrar.

Solução de problemas

A tabela a seguir lista os possíveis erros retornados e as etapas de solução de problemas associadas.

Erro Solução de problemas
arbitrary-error Ocorreu um erro arbitrário. Tente novamente ou entre em contato com o suporte.
catalog-not-found Verifique se o nome do catálogo é válido.
filtered-set-field-too-long O valor do campo está sendo usado em um conjunto filtrado que excede o limite de caracteres de um item.
id-in-body Remova quaisquer IDs de item no corpo da solicitação.
ids-too-large O limite de caracteres para cada ID de item é de 250 caracteres.
invalid-ids Os caracteres compatíveis com os nomes de ID de item são letras, números, hífens e sublinhados.
invalid-fields Confirme se todos os campos que está enviando na solicitação de API já existem no catálogo. Isso não está relacionado ao campo ID mencionado no erro.
invalid-keys-in-value-object As chaves de objeto do item não podem incluir . ou $.
item-already-exists O item já existe no catálogo.
item-array-invalid items deve ser um vetor de objetos.
items-too-large O limite de caracteres para cada item é de 5.000 caracteres.
request-includes-too-many-items Você só pode criar um item de catálogo por solicitação.
too-deep-nesting-in-value-object Os objetos de item não podem ter mais de 50 níveis de aninhamento.
unable-to-coerce-value Os tipos de itens não podem ser convertidos.
QUÃO ÚTIL FOI ESTA PÁGINA?
New Stuff!