La API de Envíos contiene todos los endpoints para crear envíos y obtener los datos de tus envíos creados. También encontrarás los endpoints para recibir notificaciones sobre las novedades del estado de tus envíos mediante un webhook.
A la hora de definir tu integración, podrás optar por NO utilizar nuestro servicio de distribución de tarjetas.
En ese caso, los grupos de afinidad reflejarán la configuración que hayas elegido. Además, al momento de crear una tarjeta o un lote de tarjetas, te devolveremos un identificador en el campo shipment_id
, que te recomendamos almacenar en tu integración ya que lo necesitarás para hacer el retiro. Las tarjetas estarán disponibles para su retiro en la planta embozadora definida en la integración.
El endpoint /shipping/v1/
se usa para crear un nuevo envío de una tarjeta innominada. Ten en cuenta que para crear un envío, es requisito que hayas creado un lote de tarjetas innominadas.
El campo region
se corresponde con:
El campo courier.tracking_url de la respuesta, estará disponible una vez que el envío sea confirmado por el partner logístico correspondiente. Hasta entonces, tendrá valor nulo
documentNumber
y documentType
no serán requeridos.region
con el código UF de dos caracteres. Ejemplo: 'SP' para São Paulo
Si operas en Colombia, el campo zip_code
es opcional, es decir que podrás no enviarlo.
El endpoint /shipping/v1/
te permite buscar un grupo de envios según los atributos que especifiques.
Podrás filtrar y ordenar los envíos siguiendo esta documentación.
Los atributos para ordenar son:
shipment_type
status
status_detail
created_at
El endpoint /shipping/v1/{shipment_id}
te permite obtener información sobre un envío en particular.
¿Tienes dudas sobre el estado de los envíos? Te contamos qué significa cada uno en nuestra documentación.
Deberás especificar el shipment_id
para hacer la consulta.
Para los envíos hacia un warehouse y también para los que se realizan en México, no devolveremos un ID externo de seguimiento, ¡pero descuida! Te mantendremos informado sobre el estado del envío desde el Dashboard y también vía webhooks.
Debes incluir este endpoint en tu servicio para que podamos comunicarte las novedades de los envíos en tiempo real.
Si tienes dudas sobre cómo configurar un webhook, visita nuestra documentación.
Encuentra más información sobre el estado de los envíos en nuestra documentación.
api-secret
tenés que usar en el caso que se hayan configurado múltiples pares de api-key
y api-secret
.