Crear entidades personalizadas

Esta operación te permite crear un nuevo elemento dentro de una tabla específica de entidades personalizadas.

Sigue los principios de la arquitectura REST y cumple con el estándar OData v4.01

[POST] Endpoint de entidades personalizadas

https://api2.saleslayer.com/rest/Catalog/CustomEntity('{customEntityDenominator}')

Realizar una solicitud

• Usa el método HTTP: POST.
• Incluye la API key en las cabeceras de la solicitud para la autenticación.
• El cuerpo de la solicitud debe enviarse en formato JSON.
• Debes incluir los atributos usando sus identificadores, no los nombres de base de datos.
• El campo xxxx_ref es obligatorio.

Ejemplo 1 del cuerpo de la solicitud:

{
  "sales_ref": "SM001",
  "sales_title": {
    "en": "Proveedor principal",
    "es": "Proveedor principal"
  },
  "sales_description": "Distribuidor para la región EMEA",
  "sales_status": "D",
  "sales_logo": "logo_emea.png",
  "sales_productrelated": "ref-004"
}

Los valores de un campo de elemento relacionado no se validan. Puede ser cualquier cadena de texto. Contiene las referencias de los elementos separadas por comas y sin espacios.

El prefijo (sales) depende del nombre técnico de la entidad definida.

Campos como xxxx_stat, xxxx_title o xxxx_description deben existir previamente.

Respuesta

201 Created

Si el elemento se ha creado correctamente.

Ejemplo de cabeceras de respuesta:

content-length: 0
date: Thu, 28 May 2025 10:06:02 GMT
location: http://api2-rest-release-queen.kp.saleslayer.com/CustomEntities('Sales')/Item(3)

Ten en cuenta que la respuesta devuelve el Item, que resulta útil como referencia para futuras operaciones.

400 Bad Request

• Falta un campo obligatorio: "Attribute xxxx_ref is mandatory"
• Campo no reconocido: "Field xxxx_size is not valid"

401 Unauthorized

La API key no existe o no es válida.

403 Forbidden

El usuario no tiene permisos para crear variantes.

404 Not Found

La entidad personalizada no existe o se ha eliminado.

412 Precondition Failed

El sistema no está en un estado válido para realizar la operación.

500 Internal Server Error

Fallo inesperado del sistema

Limitaciones

• Solo se puede crear un elemento por solicitud.
• La creación por lotes no está disponible actualmente.
• Los nombres de los campos varían según la entidad.
• El sufijo del campo depende del nombre de la entidad (xxxx_).
• No se permiten nombres de campo duplicados ni campos que no existan en la estructura definida.
• No se pueden incluir campos internos como xxxx_id, xxxx_modify, xxxx_creation, etc.
• Las imágenes deben referenciarse por nombre y deben existir previamente.
• Todos los cambios se registran automáticamente en la tabla de actividad (_activity_).

Compatibilidad con campos multidioma

Si tu cuenta tiene configurados campos multidioma, puedes incluir valores en varios idiomas para cada atributo.

{
  "brands_ref": "NIKE_001",
  "brands_title": {
    "en": "Nike",
    "es": "Nike"
  },
  "brands_description": {
    "en": "Marca deportiva global",
    "es": "Marca deportiva global"
  },
  "brands_stat": "V"
}

Condiciones de los campos multidioma

Puedes enviar valores multidioma para los campos solo si:

• El campo está definido como multidioma.
• El idioma está admitido en tu cuenta.

Errores habituales:

• Idioma no admitido → 400 - Invalid language code
• Campo no multidioma → 400 - Attribute does not support multi-language