Endpoints para Temporada

La entidad Season en el contexto de moda representa un periodo dentro del año en el cual se lanzan nuevas colecciones o productos. Esta entidad puede ser esencial para diferenciar dos productos similares pero de distintas temporadas. Si el tipo de la característica no es moda, en ese producto no existirá una temporada.

Características Comunes de las Temporadas

1. Identificación Única: La entidad Season consta de un identificador único que sirve para distinguirlo de las demás temporadas y referenciarla con facilidad. Además cuenta con un campo idRemote, que hace referencia al id que puede estar almacenado en la base de datos del ERP del cliente.

2. Datos de Temporada: Una temporada tiene información asociada como descripción, fechas de creación y última actualización, tipo de temporada, posición, etc.

3. Actividades y Registro: Las actividades realizadas por una temporada dentro del sistema, como la creación o eliminación de recursos, pueden ser registradas.

Endpoints

GET/Season/getSeason

Devuelve una lista con todas las temporadas registradas en el sistema.

Descripción

Este endpoint recupera una lista paginada de las temporadas registradas en el sistema. Permite a los clientes obtener datos de las temporadas basados en parámetros de paginación como el número de página (page) y el número de ítems por página (pageSize). La respuesta incluye información detallada sobre cada temporada.

Parámetros

Nombre	Descripción	Tipo	Valor Predeterminado
page	Número de página	Integer	1
pageSize	Número de ítems por página	Integer	10

Respuestas

JSON

{
  "data": [
      {
      "id": "string",
      "idRemote": "string",
      "description": "string",
      "seasonPosition": 0,
      "seasonType": "string",
      "active": true,
      "createdAt": "string",
      "updatedAt": "string"
      }
  ],
  "pagination": {
      "totalItems": 0,
      "itemsPerPage": 0,
      "currentPage": 0,
      "totalPages": 0,
      "nextPageUrl": "string"
  }
}

XML

<?xml version="1.0" encoding="UTF-8"?>
<export>
  <data>
    <item>
      <id>string</id>
      <idRemote>string</idRemote>
      <description>string</description>
      <seasonPosition>0</seasonPosition>
      <seasonType>string</seasonType>
      <active>true</active>
      <createdAt>string</createdAt>
      <updatedAt>string</updatedAt>
    </item>
  </data>
  <pagination>
    <totalItems>0</totalItems>
    <itemsPerPage>0</itemsPerPage>
    <currentPage>0</currentPage>
    <totalPages>0</totalPages>
    <nextPageUrl>string</nextPageUrl>
  </pagination>
</export>

👉Prueba este endpoint🌱

POST/Season/create

Crear una nueva temporada.

Registro de Temporada en la API: Uso del Método POST

Actualmente, nuestro método POST en la API está diseñado para manejar exclusivamente el formato JSON. Para registrar temporadas de manera efectiva, es crucial seguir un proceso que garantice la integridad de los datos y la funcionalidad adecuada del sistema.

Detalles del Método POST:

En este endpoint, se deben proporcionar datos estructurados en formato JSON que incluyan información crucial como descripción, posición, tipo de temporada y detalles adicionales según sea necesario. El proceso garantiza que cada temporada tenga una identidad única y esté correctamente configurado para interactuar con la plataforma de manera segura y eficiente. El campo idRemote proporcionado en la creación de una nueva entidad se corresponde con el idRemote que quiera darle el usuario y el sistema creará automáticamente un id local.

El cuerpo de la solicitud debe seguir el siguiente esquema en formato JSON:

[
  {
      "idRemote": "string",
      "description": "string",
      "seasonPos": 0,
      "seasonType": "string",
      "active": true
  }
] 

Es posible añadir varias temporadas a través de la misma solicitud separándolos con comas dentro del array en el cuerpo de la solicitud.

👉Prueba este endpoint🌱

DELETE/Season/delete/{id}

Eliminación de Temporada

Descripción

El método DELETE permite la eliminación de temporadas utilizando su identificador único. Este campo id puede ser tanto el identificador generado por la base de datos del B2B como el idRemote que usted nos proporciona al registrar las temporadas. Es importante destacar que al eliminar una temporada, también se elimina en el Pedido correspondiente. Una vez eliminada, la Temporada se registra en el Historial de Eliminados.

Parámetros

Nombre	Descripción	Tipo
id	Identificador de Temporada	String

👉Prueba este endpoint🌱

Posibles Errores en la Respuesta

Error	Código	Respuesta
Este error ocurre cuando no se puede establecer una conexión con la base de datos. Es un problema interno del servidor.	500	{"code": 500,"error": "Database connection failed."}
Este error ocurre cuando no puede insertar o actualizar y en la dbs de pruebas.	500	{"code": 500,"error": "Invalid connection name, you cannot insert in default"}
Este error indica que falta un parametro.	400	{"code": 400,"error": "Parameter $parameter is required"}
Este error indica que no está autorizado.	401	{"code": 401,"error": "Unauthorized"}
Este error indica que no ha sido posible encontrar un registro.	404	{"code": 404,"error": "No entity found for Season with $id."}
Este error ocurre cuando intenta insertar un registro que ya existe	409	{"code": 409,"error": "Duplicate entry"}
Este error ocurre cuando intenta enviar demasiadas solicitudes en un corto periodo de tiempo.	429	{"code": 429,"error": "Too Many Requests"}