warehouse icon

warehouse

2.0.x
(0 reviews)
La API de Warehouse ofrece funcionalidad para la gestión de pedidos, clientes, proveedores, artículos, stock… dentro del almacén de Correos.

El API de warehouse ofrece funcionalidad para la gestión de pedidos, clientes, proveedores, artículos, stock, devoluciones y códigos de barrar dentro de los almacenes de Correos. Este API transforma las distintas peticiones de los clientes al formato adecuado para Correos y lo envía para su procesamiento interno.

Las respuestas de esta API pueden ser varias, en caso de los POST, PUT y DELETE la respuesta es asíncrona así que solo nos informará de si ha podido enviarse el mensaje con éxito o no. En el caso de los GET al cliente se le devolverán los datos solicitados con el formato que se describe en este manual.

Las distintas operaciones existentes en este API son:

  • Alta, modificación y baja de clientes
  • Alta, modificación y baja de proveedores
  • Alta, modificación y baja de artículos
  • Alta, modificación y baja de pedidos de entrada
  • Alta, modificación y baja de pedidos de salida
  • Alta, modificación y baja de devoluciones
  • Alta y baja de códigos de barras
  • Consulta de pedido de entrada por fecha
  • Consulta de pedido de salida por fecha
  • Consulta de devolución de clientes
  • Consulta de devolución de proveedores
  • Consulta de la situación de stock por fecha
  • Consulta de la regularización de stock por fecha
  • Consulta de la situación lógica

Características del API

Nota: En esta documentación se incluyen ejemplos ilustrativos usando curl. Esto no significa que esté obligado a usar curl, para utilizar el API puede emplear cualquier programa que permita realizar peticiones HTTP.

Sobre las políticas de seguridad requeridas

Antes de poder usar el API lo primero será conseguir las credenciales de acceso necesarias para cumplir con las políticas de seguridad requeridas.

Client ID Enforcement

El API espera unas cabeceras con pareja clave/valor en sus peticiones. Todas las llamadas al API deberán incluir estos datos.

CabeceraValor
client_idSuministrado una vez solicitado el acceso al API
client_secretSuministrado una vez solicitado el acceso al API

Antes de que a una aplicación cliente se le permita consumir una API protegida con esta política se debe solicitar acceso a la API.

Desde el propio Exchange, o el portal de acceso a las APIs que se esté usando, existirá una opción de Solicitar acceso. Si no ve esa opción quiere decir que esa API no admite solicitudes de acceso y deberá ponerse en contacto con el equipo de soporte del API.

Una vez solicitado el acceso, la petición pasa por un flujo de aprobación. Una vez finalizado ese flujo, y aprobado por el propietario del API, recibirá un email con las credenciales de acceso.

Las credenciales se adjuntarán como cabeceras de todas las invocaciones al API tal como muestra el siguiente ejemplo usando curl:

curl --location 'https://api1.correos.es/<organization-name>/<api-name>/api/v1/myResource' \
--header 'client_id: 123456' \
--header 'client_secret: my_secret'

Guía de uso

Tengan en cuenta que este API está disponible tanto para RI como DMZ, pero los mismos credenciales client id/client secret no funcionarán para ambas versiones a no ser que así se hayan pedido.

Además, sepan que este API se trata de una pasarela que envía los datos recibidos a la aplicación de destino correspondiente sin realizar cambios sobre ellos. Sin embargo, existe una pequeña modificación a la hora de llamar a este API que hay que tener en cuenta: todos los cuerpos de las peticiones deberán ir en texto plano. Este API se encargará de enviarlos en formato JSON a la aplicación de destino.

Reviews