Última Fecha de Actualización del Catálogo

El catálogo de productos es dinámico y puede cambiar en cualquier momento. Para facilitar la detección de cambios en el catálogo, la API proporciona el método CatalogLastUpdatedDateTime, que devuelve la fecha y hora de la última modificación en el catálogo de productos.

Este método permite al Colaborador verificar si se han realizado cambios en el catálogo desde la última consulta y, en caso necesario, actualizar su información interna.

1. Método de Acceso

Parámetro

Descripción

URL

{baseurl}/api/cataloglastupdateddatetime?PartnerId={partnerId}

Verbo HTTP

GET

2. Estructura de Datos de Envío

Parámetros Opcionales

Parámetro

Descripción

api-version

Permite indicar la versión de la API a utilizar (Ejemplo: 3.47). Por defecto se usa 3.21.

 

3. Estructura de la Respuesta

La API devolverá la última fecha de actualización del catálogo en formato ISO 8601 junto con información sobre el estado de la consulta.

Campo

Tipo

Descripción

LastUpdatedDateTime

string

Fecha y hora de la última actualización del catálogo en formato ISO 8601.

Success

boolean

true si la consulta se realizó correctamente, false si hubo un error.

TimeStamp

string

Fecha y hora en que se realizó la consulta.

ErrorMessage

string

Mensaje de error si la consulta no fue correcta (null si fue exitosa).

ErrorCodes

array

Lista de códigos de error si hubo fallos en la consulta.

ErrorEntityBreakDown

array

Lista de errores específicos con su ID y nombre asociado.

 

4. Ejemplo de Llamada a la API

GET {baseurl}/api/cataloglastupdateddatetime?PartnerId={partnerId}

5. Ejemplo de Respuesta Exitosa

{

    "LastUpdatedDateTime": "2025-01-15T14:23:44",

    "Success": true,

    "TimeStamp": "2025-01-15T14:30:00",

    "ErrorMessage": null,

    "ErrorEntityBreakDown": []

}

6. Ejemplo de Respuesta con Error

{

    "Success": false,

    "TimeStamp": "2025-01-15T14:30:00",

    "ErrorMessage": "Invalid PartnerId",

    "ErrorEntityBreakDown": [

        {

            "Id": "12345",

            "Name": "PartnerId Not Found"

        }

    ]

}

7. Consideraciones Finales

  • Este método es ideal para optimizar el rendimiento de la aplicación, ya que permite consultar el catálogo solo cuando hay cambios y evitar llamadas innecesarias.
  • La respuesta siempre estará en formato ISO 8601, lo que facilita su procesamiento en diferentes sistemas.
  • Si el campo Success es false, la API devolverá un mensaje de error explicando el problema.

¿Te ha parecido útil este artículo?