Documentacion API INTERRAPIDISIMO

Documentación Servicio Web API REST
Integraciones B2B
GUIA DEL DESARROLLADOR
Release 6
Ultima Actualización: Abril 2022

1 CONTROL DE VERSIONES
Fecha Detalle del Cambio Autor

2018-10-03 Pre- Release de API B2B Integraciones Interrapidisimo versión 2.0 Cristhian C. Gómez N - Miguel Angel Lara
2018-11-07 Mejoras en documentación y feedback de cliente Miguel Angel Lara
2018-12-15 Cambio wrapper de Envío Cotización valor admisión. Cristhian C. Gómez N
2019-06-12 Actualización cambio esquema de autenticación y autorización Cristhian C. Gómez N
2019-07-20 Adición “Conceptos / Datos Básicos de Consumo” Cristhian C. Gómez N
2019-08-03 Actualización Ilustraciones y mejoras al formato del documento Cristhian C. Gómez N – Edson J. Nieto
2019-10-04 Actualización de Mock Request/ Response Edson Nieto
2021-03-15 Adición longitud de caracteres en campos tipo string José Manuel Sánchez J.
2021-03-24 Adición tablas descriptivas adicionales José Manuel Sánchez J.
2021-03-26 Adición descripción Notificación de Estados (PUSH) Alfredo Antonio De Castro G.
2021-04-14 Ajuste de información datos básicos consumo de servicio y Servicio José Manuel Sánchez J.
Cotizador
2021-04-19 Inclusión nuevas APIs construídas José Manuel Sánchez J.
2021-05-31 Sustitución API Admisión por Envío Admisión José Manuel Sánchez J.
2021-08-31 Inclusión nuevas APIs construídas (Recogidas y Planilla Preenvíos) José Manuel Sánchez J.
2021-10-19 Inclusión API para impresión formato guía por lote José Manuel Sánchez J.
2021-11-23 Inclusión API consulta de estado envios y URL “Sigue tu Envío” José Manuel Sánchez J.
2022-02-24 Inclusión API para impresión formato guía pequeño José Manuel Sánchez J.
2022-04-08 Ajuste response de salida en Json proceso Push José Manuel Sánchez J.
Documentación B2B API REST – Release 3.0
2
3
2 CONTENIDO
1 Control de Versiones .............................................................................................................................................................................................................. 2
3 Tabla de Ilustraciones ............................................................................................................................................................................................................. 5
4 Índice de tablas ....................................................................................................................................................................................................................... 5
5 Objetivo: ................................................................................................................................................................................................................................. 6
6 Overview Flujo Básico Integración (BPMN) ............................................................................................................................................................................ 6
7 Datos Básicos Consumo Servicios ........................................................................................................................................................................................... 7
8 Conceptos Básicos de Consumo ............................................................................................................................................................................................. 8
9 Servicio Autenticación - Seguridad ....................................................................................................................................................................................... 12
10 Servicio Cotización: ............................................................................................................................................................................................................. 14
11 Servicio Admisión Pre Envío: .............................................................................................................................................................................................. 17
12 Consulta para impresión formato guía: .............................................................................................................................................................................. 25
13 Consulta para impresión formato guía Pequeña:............................................................................................................................................................... 27
14 Consulta para impresión formato guía Por lote: ................................................................................................................................................................ 29
15 Servicio de Consulta de estados de envíos:........................................................................................................................................................................ 32
16 Consulta de estados sitio “sigue tu envío”: ........................................................................................................................................................................ 35
17 Notificación de estados (push): .......................................................................................................................................................................................... 36
18 Servicio Recogidas: ............................................................................................................................................................................................................. 41
19 Servicio Planilla PreEnvíos: ................................................................................................................................................................................................. 44
20 Servicio Localidades:........................................................................................................................................................................................................... 47
21 Anexo 1 – Matriz de Estados Logísticos.............................................................................................................................................................................. 51
22 Anexo 2 – Motivos de Devolución ...................................................................................................................................................................................... 53
23 Anexo 3 – ejemplos Código cURL de los servicios .............................................................................................................................................................. 60
4
3 TABLA DE ILUSTRACIONES
Ilustración 1 - Overview Flujo Básico Consumo Servicios Integración ........................................................................................................................................................... 6
Ilustración 2 - Flujo servicio autenticación .................................................................................................................................................................................................. 12
Ilustración 3 - Ejemplo response autenticación ........................................................................................................................................................................................... 13
Ilustración 5 - Ejemplo Response Servicio Cotización .................................................................................................................................................................................. 16
Ilustración 6 - Headers Request Servicio Admisión ...................................................................................................................................................................................... 21
Ilustración 7 - Ejemplo Request Admisión Envío y Response ....................................................................................................................................................................... 23
4 ÍNDICE DE TABLAS
Tabla 1 - Datos Básicos (URL) Consumo APIs ................................................................................................................................................................................................ 7
Tabla 2 – Forma de Pago ............................................................................................................................................................................................................................... 8
Tabla 3 - Estados de la Guía .......................................................................................................................................................................................................................... 8
Tabla 4 - Tipos de Entrega ............................................................................................................................................................................................................................. 9
Tabla 5 – Tipo de Envío .................................................................................................................................................................................................................................. 9
Tabla 6 - Tipo de Identificación.................................................................................................................................................................................................................... 10
Tabla 7 - Identificación servicios .................................................................................................................................................................................................................. 11
Tabla 8 - Headers Request Servicio Autenticación....................................................................................................................................................................................... 13
Tabla 9 - Body Response Servicio Autenticación.......................................................................................................................................................................................... 13
Tabla 10 - Body Request Servicio Cotización ............................................................................................................................................................................................... 14
Tabla 11 - Response Servicio Cotizador ....................................................................................................................................................................................................... 15
Tabla 12 - Headers Request Servici .............................................................................................................................................................................................................. 17
Tabla 13 - Body Request Servicio Admisión ................................................................................................................................................................................................. 20
Tabla 14 - Estructura JSON para notificaciones de estado (PUSH) .............................................................................................................................................................. 40
5
5 OBJETIVO:
• Permitir la integración de diferentes clientes/plataformas a los servicios disponibles en Inter Rapidísimo.
6 OVERVIEW FLUJO BÁSICO INTEGRACIÓN (BPMN)
Ilustración 1 - Overview Flujo Básico Consumo Servicios Integración
6
7 DATOS BÁSICOS CONSUMO SERVICIOS
URL Recurso Descripción Ambiente

https://stgwww3.interrapidisimo.com/ApiVentaCreditostg /Autorizacion/token URL Base servicio de Pruebas
seguridad Integraciones
https://stgwww3.interrapidisimo.com/ApiServInterStg /apiCotizadorcliente/Resultad URL Servicio de Cotización de Pruebas
oListaCotizar precios de envío
https://stgwww3.interrapidisimo.com/ApiVentaCreditostg / URL Servicio Admisión de Pre Pruebas

api/Admision/InsertarAdmisio Envío
n
https://stgwww3.interrapidisimo.com/ApiVentaCreditostg /api/ClientesCredito/Consulta URL Servicio para consulta Pruebas

rEstadosGuiasCliente tracking guías
https://www.interrapidisimo.com /sigue-tu-envio/?guia= URL para consulta de estado Producción

[número de guía] de envío en sitio web
DIRECCIÓN API CLIENTE (PUSH) N/A URL Api de cliente para enviar Pruebas
las notificaciones de estado
https://stgwww3.interrapidisimo.com/ApiVentaCreditostg /api/Admision/ObtenerBase6 URL servicio Consulta Guía Pruebas
/ 4PdfPreGuia/ para impresión
https://stgwww3.interrapidisimo.com/ApiVentaCreditostg /api/Admision/ObtenerBase6 URL servicio Consulta Guía Pruebas

/ 4PdfPreGuias/ para impresión por lote
https://stgwww3.interrapidisimo.com/ApiVentaCreditostg /Localidades/Obtenerlocalida URL servicio Localidades Pruebas

desVentaCredito/
https://stgwww3.interrapidisimo.com/ApiVentaCreditoStg /api/Recogida/InsertarRecogi URL servicio Recogidas Pruebas

daCliente/ esporádicas
https://stgwww3.interrapidisimo.com/ApiVentaCreditoStg /api/Planilla/GenerarPlanillaR URL servicio planilla Pruebas

ecoleccionPreenvios
Tabla 1 - Datos Básicos (URL) Consumo APIs
7
8 CONCEPTOS BÁSICOS DE CONSUMO
Forma de Pago (Integer)
Valor Nombre Descripción
2 CRÉDITO Pago sujeto a un cupo de crédito previamente otorgado (aplica para clientes
corporativos, por lo que es la opción a usar por defecto)
Tabla 2 – Forma de Pago
Estados de la Guía (Integer)

1 ADMITIDA Estado que se origina al momento de capturar los datos de la guía para entrega.
2 CENTRO ACOPIO Estado que se origina al momento de ingresar el paquete a las bodegas de Inter
Rapidísimo.
3 TRANSITO NACIONAL Estado que se origina cuando un paquete es transportado en interconexiones
departamentales.
4 TRANSITO REGIONAL Estado que se origina cuando un paquete es transportado al interior de un
departamento.
8 TELEMERCADEO Estado que se origina cuando un envío no se entregó de manera exitosa y se intenta
contactar al cliente.
10 DEVOLUCIÓN RATIFICADA Estado que se origina cuando se debe devolver el envío al remitente de forma
exclusiva.
11 ENTREGADA Estado que se origina cuando el envío se entrega de forma exitosa.
15 ANULADA Estado que se origina cuando se cancela un envío.
18 TRANSITO URBANO Estado que se genera cuando el envío se encuentra en ruta al interior de una ciudad.
21 INCAUTADO Estado que se origina cuando las autoridades aduaneras, militares o cuerpos armados
del estado retienen el paquete.
31 DISTRIBUCIÓN Estado que se origina cuando el paquete está en ruta para entrega al cliente.
Tabla 3 - Estados de la Guía
8
Tipos de Entrega (Integer)
1 ENTREGA EN DIRECCION Entrega en la dirección solicitada (Ciudad o municipio)
2 RECLAME EN OFICINA Entrega a cliente el paquete en centro de servicio (tipo reclame oficina).
Tabla 4 - Tipos de Entrega
Tipo de Envío (Integer)

Valor Nombre Peso Mínimo (Kg) Peso Máximo (Kg)
1 SOBRE CARTA 0.0000 10.000
2 SOBRE MANILA 0.0000 20.000
3 PAQUETE PEQUEÑO 0.0000 20.000
4 TULA 0.0000 1.000.000
5 CAJA PEQUEÑA 40.000 50.000
6 OTROS 60.000 7.000.000
7 BULTO 60.000 7.000.000
9 PAQUETE 30.000 3.000.000
10 CAJA 60.000 1.200.000

Tabla 5 – Tipo de Envío
Tipo de Identificación (Integer)
9
CC CÉDULA DE CIUDADANÍA
CE CÉDULA DE EXTRANJERÍA
NI NIT
TI TARJETA DE IDENTIDAD
Tabla 6 - Tipo de Identificación
Identificación Servicio (Integer)
1 Rapi Hoy Rapi hoy mensajeria Puerta a Puerta
2 Rapi AM Rapi AM mensajeria Puerta a Puerta
3 Mensajería Mensajería Puerta a Puerta
4 Rapi Masivos Rapi Masivos
5 Rapi Promocional Rapi Promocional
6 Rapi Carga Terrestre Rapi Carga Puerta a Puerta
7 Rapi Carga Contrapago Rapi Carga Contrapago
8 Giros Giros
9 Inter Viajes Inter Viajes
10 Trámites Trámites
11 Internacional Descripción Servicio Internacional
12 Centros de Correspon. Centros de Correspondencia
10
13 Rapi Personalizado Rapi Personalizado
14 Rapi Envíos Contrapago Rapi Envíos Contrapago
15 Notificaciones Notificaciones Judiciales
16 Rapi Radicado Carta Porte/Rapi Radicado
17 Rapi Carga Carga Express Puerta a Puerta
18 Komprech Komprech
19 Rapi Tula Rapi Tula
20 Rapi Valores Msj Rapi Valores Mensajeria
21 Rapi Valores Carga Rapi Valores Carga
22 Rapi Carga Consolidada Rapi Carga Consolidada
23 Rapi Valijas Rapi Valijas
24 Otros Ingresos Otros Ingresos

Tabla 7 - Identificación servicios
NOTA:
Para conocer el identificador de ciudad DANE consultar la URL https://geoportal.dane.gov.co/consultadivipola.html, o consultar el

archivo adjunto (DANE_DIVIPOLA_20201230.xls) Ultima Fecha Actualización 30 de Diciembre de 2020
DANE_Divipola_20
201230.xlsx
11
9 SERVICIO AUTENTICACIÓN - SEGURIDAD
Servicio utilizado para obtener token de autenticación / autorización para el consumo de servicios.
Ilustración 2 - Flujo servicio autenticación
12
Request
Método: GET
HEADERS:
Nombre Parámetro Tipo Dato Descripción Valor (Ejemplo)

x-app-signature String(2510) Firma digital (usuario) generada por el sistema (Inter Rapidísimo) userXYZ
para la aplicación de integración en consumo (3rd-Party)
Authorization String(250) Header de autorización Básica (Basic + Espacio + codificación en Basic Zm9vOmJhcg==
Base64 de usuario:contraseña)
Tabla 8 - Headers Request Servicio Autenticación
BODY:
Nombre Parámetro Tipo Dato Descripción Valor

grant_type String(8) Clave de tipo x-www-form-urlencoded, necesario para password
la la generación del token
Response:

Access_token String(250) Token utilizado para autenticar request "Ij^M>y!?f~jf%ft()Ujb¿|_VoX|yJDxlah<-
en los diferentes servicios q>/%m#x>BYAK}LN>UwRT**kFC`$"
Token_tipe String(250) Tipo de token bearer

ExpiresIn String(250) Fecha y hora de expiración del token 86399
en formato general
Tabla 9 - Body Response Servicio Autenticación
Ilustración 3 - Ejemplo response autenticación
13
10 SERVICIO COTIZACIÓN:
Servicio utilizado para obtener los datos de precio, servicio y embalaje (Tipo de Envío).
Método : GET
HEADERS:

x-app-signature String(250) Firma digital (usuario) generada por el userWxyzStg
sistema (Inter Rapidísimo) para la aplicación
de integración en consumo (APIKEY / 3rd-
Party)
x-app-security_token String(250) Campo Access_token, retorno de servicio Bearer Ij^M>y!?f~jf%ft()Ujb¿|_VoX|yJDxlah<-
de autenticación. q>/%m#x>BYAK}LN>UwRT**kFC`$
Tabla 10 - Headers Request Servici
Request
https://stgwww3.interrapidisimo.com/ApiServInterStg/api/Cotizadorcliente/ResultadoListaCotizar/{idCliente}/{idCiudadOrigen}/{idCiudadDestino}/{pes
o}/{valorDeclarado}/{idTipoEntrega}/{fecha}
BODY:

IdCliente integer Identificador de cliente registrado en el sistema Inter Rapidísimo 5850
IdCiudadDestino String(8) Identificador de ciudad establecido por el DANE (Departamento 05001000 (Medellin/Antioquia)
Administrativo Nacional de Estadística) de la ciudad de destino.
IdCiudadOrigen String(8) Identificador de ciudad establecido por el DANE (Departamento 11001000 (Bogotá / Cundinamarca)
Administrativo Nacional de Estadística) de la ciudad de origen.
IdTipoEntrega String(3) (Ver Tabla Tipo de Entrega) 1
Peso decimal Peso neto del envío (Kilogramos) 2
ValorDeclarado decimal Valor comercial del envío expresado en (COP $) 250000
Fecha string Fecha de Cotización 13-04-2021
Tabla 11 - Body Request Servicio Cotización
14
Response

IdServicio integer Identificador del servicio para la cotización 3
Precio.Impuestos decimal Valor del impuesto 0.0
Precio.ValorKiloInicial decimal Valor del kilo inicial de la entrega 5250.0000
Precio.ValorKiloAdicional decimal Valor del kilo adicional de la entrega 2200.0000
Precio.Valor decimal Valor subtotal del servicio 7450.0000
Precio. ValorContraPago decimal Valor contrapago (si aplica) 0.0
Precio. ValorPrimaSeguro decimal Valor de prima seguro, ralacionado con el servicio 600.0000
PrecioCarga decimal Precio de carga 0.0

Mensaje String(250) Mensaje
NombreServicio Strim(25) Nombre del servicio Mensajería
TiempoEntrega integer Tiempo estimado en días de la entrega 3
FormaPagoServicio.IdServ integer Identificador del servicio para la cotización 3
icio
FormaPagoServicio.IdFor integer Identificacor de forma de pago
maPago
FormaPagoServicio.Descri String(250) Descripción o nombre de la forma de pago
pción
FechaEntrega String(250) Fecha y tiempo estimado de la entrega 2021-04-16T18:00:00
Tabla 12 - Response Servicio Cotizador
Ejemplo Request Servicio Cotización
https://stgwww3.interrapidisimo.com/ApiServInterStg/api/Cotizadorcliente/ResultadoListaCotizar/5855/11001000/05001000/1/30000/1/13-04-2021
Ejemplo Response:
15
Ilustración 4 - Ejemplo Response Servicio Cotización
16
11 SERVICIO ADMISIÓN PRE ENVÍO:
Descripción
Servicio utilizado en la creación de una guía (pre envío) automática. La guía generada queda con un estado de pre envío y queda en estado Admitido
una vez se haga el ingreso efectivo en nuestro Centro de Acopio.
URL: https://stgwww3.interrapidisimo.com/ApiVentaCreditoStg/api/Admision/InsertarAdmision
Método: POST
HEADERS:

Party)
Tabla 13 - Headers Request Servici
BODY:

IdClienteCredito integer Identificador del cliente 2538
Identificador de la sucursal del cliente,

CodigoConvenioRemitente integer 11991
remitente del envío
IdTipoEntrega Integer Ver tabla tipos de Entrega 1
Indicador de si es un envío con

AplicaContrapago bool "False"
Contrapago (True para si, False para no)
IdServicio integer Identificador del Servicio (Ver tabla 3

Identificación Servicio o el retorno
17
Collection “Servicios” Servicio de
Cotización)
Peso decimal Peso registrado para el envío (en kg) 55
Medida registrada del “largo” del envío

Largo decimal 10,3
(en centimetros)
Medida registrada para el “ancho” del

Ancho decimal 11,5
envío (en centimetros)
Medida registrada para el “alto” del

Alto decimal 45,3
envío (en centimetros)
“No. Orden 123456 - Ropa

DiceContener String(50) Descripción del contenido de envío.
deportiva”
ValorDeclarado decimal Valor declarado por el remitente. 250000
Identificador del tipo de envío, (Ver

IdTipoEnvio integer 1
Tabla Tipos de Envío)
Forma de pago del envío (Ver tabla

IdFormaPago integer 3
Forma de Pago)
Numero de piezas del envío (se coloca 1

NumeroPieza integer por defecto, pues la relación es 1 pieza, 1 1
envío)
Objeto con la información del

Destinatario Object<Tercero>
destinatario del envío
Identificador tipo de identificación del

Destinatario.tipoDocumento String(2) destinatario (Ver Tabla Tipos “CC”
Identificación)
Número de identificación del

Destinatario.numeroDocumento String(25) “1020753895”
destinatario.
18
Nombre del destinatario (nombre
Destinatario.nombre String(50) "Juan Carlos"
empresa, en caso detipo documento NIT)
Primer apellido del destinatario (si es tipo

Destinatario.primerApellido String(50) “Solano”
documento NIT,enviar null)
Segundo Apellido del destinatario

Destinatario.SegundoApellido String(50) “Martínez”
(opcional, enviar null)
Número telefónico del destinatario del

Destinatario.Telefono String(25) “12939648”
envío.
Avenida Calle 3 # 41ª-57B Edificio

Destinatario. Direccion String(250) Dirección de entrega del envío.
123 Torre 3 APTO 43
Campos requeridos en un proceso

Destinatario.idDestinatario integer 0
posterior (Se debe dejar en 0)
Campos requeridos en un proceso

Destinatario.idRemitente integer 0
posterior (Se debe dejar en 0)
Identificador de la ciudad de destino

Destinatario.idLocalidad String(8) “11001000”
(Código DANE).
Código del convenio relacionado con el

Destinatario.CodigoConvenio integer 0
cliente destino (por defecto, se daja en 0)
ID de la sucursal del cliente cuando el

Destinatario.ConvenioDestinatario integer destinatario es cliente convenio (por 0
defecto, se daja en 0)
Dirección de correo electrónico del

Destinatario.correo String(50) juan.c.solano.v@mail.com
destinatario
Descripción del tipo de entrega

DescripcionTipoEntrega String(50) seleccionado (opcional, se envía en ""
blanco)
19
Descripción del tipo de envío
NombreTipoEnvio String(50) "SOBRE CARTA"
seleccionado
Código del convenio relacionado con el

CodigoConvenio integer 0
cliente destino (por defecto, se daja en 0)
Id de la sucursal del convenio (por

IdSucursal integer 0
Id del cliente convenio, si el destinatario

IdCliente integer se encuentra como cliente nuestro (por 0
Objeto con la información requerida

cuando se selecciona el servicio de
RapiRadicado Object<Tercero>
RapiRadicado. Se puede descartar si no
se utiliza este servicio.
Numero de folios de la radicación (solo

RapiRadicado.numerodeFolios integer aplica para el servicio RapiRadicado, en 7
los demás casos, se coloca 0)
Código generado del RapiRadicado (solo

RapiRadicado.CodigoRapiRadicado integer aplica para el servicio RapiRadicado, en 25541645
los demás casos, se coloca 0)
Descripción adicional del remitente sobre

"Al frente del centro comercial
Observaciones String(250) el envío (Indicaciones, datos adicionales
xxxx"
de pedido, etc.)
Tabla 14 - Body Request Servicio Admisión
20
Ejemplo servicio envío admisión
REQUEST
Headers
Ilustración 5 - Headers Request Servicio Admisión
Ejemplo Request:
"IdClienteCredito":996, //Codigo cliente
"CodigoConvenioRemitente": 11437, //Codigo sucursal
"IdTipoEntrega":"1",
"AplicaContrapago": "False",
"IdServicio":3,
"Peso":3, //En kilogramos
"Largo":10, //En centimetros
"Ancho":10,
"Alto":10,
"DiceContener":"Camisetas",
"ValorDeclarado":50000,
"IdTipoEnvio":1,
"IdFormaPago":2,
21
"NumeroPieza":1,
"Destinatario":{
"tipoDocumento":"CC",
"numeroDocumento":"1018495152",
"nombre":"Jose Manuel",
"primerApellido":"Sanchez", //Si se debe enviar si es un cliente persona natural, es obligatorio
"segundoApellido":"Javier",
"telefono":"3012884943",
"direccion":"CARRERA 79 # 19 - 87",
"idDestinatario":0, "idRemitente":0, //Campos opcionales. Dejarlos en 0
"idLocalidad":"11001000", //Codigo DANE ciudad destinatario
"CodigoConvenio":0, //Enviar valor 0 si no es cliente convenio
"ConvenioDestinatario":0, //Enviar valor 0 si no es cliente convenio
"correo":"jomasaja@gmail.com" //Obligatorio si es cliente convenio
},
"DescripcionTipoEntrega":"",
"NombreTipoEnvio":"SOBRE CARTA",
"IdSucursal":0, //Enviar valor 0 si no es cliente convenio
"IdCliente":0, //Enviar valor 0 si no es cliente convenio
"Notificacion":null,
"RapiRadicado":{
"numerodeFolios":7, //valor ejemplo
"CodigoRapiRadicado":25541545 //valor ejemplo
}, //Enviar solo si el servicio es id 16 RapiRadicado
"Observaciones":"Prueba producción"
}
22
BODY REQUEST Y RESPONSE
Ilustración 6 - Ejemplo Request Admisión Envío y Response

IdPreenvio integer Consecutivo interno del Preenvío generado 206075
numeroPreenvio long Número de guía del Preenvío generado 240000000406
fechaVencimiento date Fecha y hora del vencimiento, según parametrización del sistema 2021-07-10T15:59:09.343
fechaCreacion date Fecha y hora de generación del preenvío 2021-07-07T15:59:09.343
valorFlete decimal Valor del flete de transporte según parametrización interna para el cliente. 300.00
valorSobreFlete decimal Valor prima seguro del trasporte, según parametrización interna para el cliente. 1000.00
23
valorServicioContrapago decimal Valor del servicio de contrapago a ser facturado al cliente corporativo por el envío. 0.0
Si la opción de aplicaContrapago no se activa en el servicio, este valor viaja en 0
24
12 CONSULTA PARA IMPRESIÓN FORMATO GUÍA:
Descripción
Funcionalidad utilizada para realizar la consulta de un pre envío ya generado, el cual devolverá el formato de la guía correspondiente para su
impresión.
Método : GET
https://stgwww3.interrapidisimo.com/ApiVentaCreditostg/api/Admision/ObtenerBase64PdfPreGuia/{numeroguia}
Header

x-app-signature String(250) Firma digital generada por el sistema (Inter userWxyzStg
Rapidísimo) para la aplicación de
integración en consumo (APIKEY / 3rd-
Party)
Tabla 17 - Headers Request Servicio consulta para re impresión guía
Request

NumeroGuia long Número de guía generado 2400057735
Tabla 18 - Request Servicio Admisión
25
Ejemplo servicio consulta impresión formato guía:
Nota: El código generado es un arreglo de Bytes codificado en Base64, la cual pueden convertir para pruebas en la siguiente página:
https://base64.guru/converter/decode/pdf. En la misma también pueden encontrar ejemplos para usar este decodificador desde código.
26
13 CONSULTA PARA IMPRESIÓN FORMATO GUÍA PEQUEÑA:
Descripción
Funcionalidad utilizada para realizar la consulta de un pre envío ya generado, el cual devolverá el formato de la guía pequeña correspondiente para su
impresión.
Método : GET
https://stgwww3.interrapidisimo.com/ApiVentaCreditostg/api/Admision/ObtenerBase64PdfPreGuiaFormatoPeq/{numeroguia}
Header

Party)
Request

NumeroGuia long Número de guía generado 2400057735
27
Ejemplo servicio consulta impresión formato guía y guía:
https://base64.guru/converter/decode/pdf. En la misma también pueden encontrar ejemplos para usar este decodificador desde código.
28
14 CONSULTA PARA IMPRESIÓN FORMATO GUÍA POR LOTE:
Descripción
Funcionalidad utilizada para realizar la consulta de uno o varios pre envío ya generados, ya sea por un listado específico o en un rango de fecha, el cual
devolverá el arreglo de bytes que corresponde al archivo pdf con los formatos de las guías preadmitidas correspondientes, para su impresión. En este
servicio podemos seleccionar el tipo de formato (media carta o pequeña) que necesitemos generar.
Método : POST
https://stgwww3.interrapidisimo.com/ApiVentaCreditoStg/api/Admision/ObtenerBase64PdfPreguias
Header

Party)
Request (ejemplo):
"IdCliente": 1057,
"IdSucursal": 2980,
"PorRangoFecha": false,
"LtsPreGuias": [240000002748,240000002745,240000002741],
"FechaInicio": null,
"FechaFinal": null,
"Formato": 2
29
}

IdCliente long Id del cliente creado en nuestros sistemas 3931
(suministrado por nosotros junto con las
credenciales)
IdSucursal long Id del sucursal creado en nuestros sistemas 17880
(suministrado por nosotros junto con las
credenciales)
PorRangoFecha Boolean Variable que condiciona el consumo del servicio true
(true, si se generarán las guías por rango de fecha
y hora; false, si se generarán los formatos
especificando un listado de guías). Por defecto,
esta variable será false.
LTSPREGUIAS Array Listado de guías, separadas por coma, que se [240000000001, 240000000002,2400000
requieren generar el formato de guía. Por temas 00003,240000000004]
de rendimiento, se limita el listado a 150 guías en
una sola solicitud. Si la variable “PorRangoFecha”
se encuentra en true, cualquier dato de esta
variable no será tenido en cuenta.
FechaInicio DateTime Fecha y hora inicio del rango de fecha a consultar 2021-08-10T00:01
para generar los formatos de guía. El sistema no
reconocerá una fecha mayor a la fecha final. Si
la variable “PorRangoFecha” se encuentra en
false, cualquier dato de esta variable no será
tenido en cuenta.
FechaFinal DateTime Fecha y hora final del rango de fecha a consultar 2021-08-12T23:59
para generar los formatos de guía. El sistema no
reconocerá una fecha menor a la fecha inicio. Si
la variable “PorRangoFecha” se encuentra en
false, cualquier dato de esta variable no será
tenido en cuenta.
30
Formato Integer Indicador del formato a generar (1: media carta; 2
2: pequeña). En caso de omitirse, por defecto
generará las guías en formato media carta (1)
Response
"fechaEjcucion": "2022-02-24T09:54:56.4947638-05:00",
"pdfGuias": "JVBERi0xLjUNCiWDkvr+DQo4OCAwIG9iag0KPDwNCi9UeXBlIC9DYXRhbG9nDQovUGFnZXMgODkgMCBSDQovQWNyb0Zvcm0gOTAgMCBSDQo+Pg0KZW5kb2Jq
DQozIDAgb2JqDQo8PA0KL0xlbmd0aDEgMjkwMDgNCi9MZW5ndGggMTMxMDkNCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlDQo+Pg0Kc3RyZWFtDQp4nO17CXQj2VlubdpKpV2lfSnti2VJ3
nd3u2257fbatnuf..................”,
"msjError": "Algunos de estos preenvíos no corresponden al cliente y sucursal ingresados",
"ltsPreenviosNoIncluidos": [240000004852,240000004851]

fechaEjcucion DateTime Fecha y hora de la ejecución del servicio (API) "2021-10-20T09:54:56.4947638-05:00"
pdfGuias Bytes Arreglo de bytes que representa el archivo "JVBERi0xLjUNCiWDkvr+DQo4OCAwIG9iag0KPD
wNCi9UeXBlIC9DYXRhbG9nDQovUGFnZXMgODkgM
codificado en Base64 de los formatos de guía
CBSDQovQWNyb0Zvcm0gOTAgMCBSDQo+Pg0KZW5k
solicitados. b2JqDQozIDAgb2JqDQo8PA0KL0xlbmd0aDEgMjk
wMDgNCi9MZW5ndGggMTMxMDkNCi9GaWx0ZXIgL0
ZsYXRlRGVjb2RlDQo+Pg0Kc3RyZWFtDQp4nO17C
XQj2VlubdpKpV2lfSnti2VJ3nd3u2257fbatnuf
..................”
msjError String(250) Mensaje de error o excepción en el resultado del "Algunos de estos preenvíos no correspo
nden al cliente y sucursal ingresados"
servicio. Esta variará según la novedad
presentada.
ltsPreenviosNoIncluidos Array Listado de pre envíos con excepción. Si aplica, los [240000004852,240000004851]
números de guías que aparecen acá tienen algún
error en su redacción o no corresponden a guías
generadas por el cliente.
31
https://base64.guru/converter/decode/pdf. En la misma también pueden encontrar ejemplos para usar este decodificador desde código de varios de
los lenguajes de programación más populares.
15 SERVICIO DE CONSULTA DE ESTADOS DE ENVÍOS:

Descripción
Funcionalidad utilizada para realizar la consulta de uno o varios envíos y obtener los estados logísticos en los que han pasado los mismos.
Método : POST
http://stgwww3.interrapidisimo.com/ApiVentaCreditoSTG/api/ClientesCredito/ConsultarEstadosGuiasCliente
Header

Party)
Request
"idCliente": 4288,
"numeroGuias": [240000005422]
Nombre Campo Tipo Dato Descripción Valor (Ejemplo)

32
IdCliente Integer Código único asignado en nuestros sistemas 4288
al cliente durante su creación. Este varía
entre el ambiente de pruebas y producción
numeroGuias Array Arreglo de uno o varios envíos admitidos [240000005422,240000005423,240000005424]
(máximo 15, separados por coma) de los
cuales se requiere consultar el tracking de
los estados logísticos por los que ha pasado
Response
{
"listadoGuias": [
"numeroGuia": 240000005422,
"estados": [
"idEstadoGuia": 2,
"nombreEstado": "Centro acopio",
"nombreCiudadOrigen": "NEIVA\\HUIL\\COL",
"nombreCiudadDestino": "BOGOTA\\CUND\\COL",
"idClienteCredito": 4288,
"fechaConsulta": "2021-11-23T11:06:59.933",
"fechaEstado": "2021-11-23T11:07:01.827"
},
"idEstadoGuia": 1,
"nombreEstado": "Admitida",
"nombreCiudadOrigen": "NEIVA\\HUIL\\COL",
"nombreCiudadDestino": "BOGOTA\\CUND\\COL",
33
"idClienteCredito": 4288,
"fechaConsulta": "2021-11-23T11:06:59.933",
"fechaEstado": "2021-11-23T11:07:00.513"
],
"mensajeGuiasNoCliente": null,
"listadoGuiasNoCliente": null
En la respuesta del servicio, por cada número de guía, se mostrarán los estados por los que ha pasado el envío, ordenados desde el más reciente al más
antiguo. Contienes los siguientes campos:
Nombre Campo Tipo Dato Descripción Valor (Ejemplo)

numeroGuia Integer Número de guía consultada. En la estructura de la 240000005422
respuesta esta variable antecede al detalle con los
estados en los que la guía ha pasado.
idEstadoGuia Integer Código del estado logístico de la guía 1
nombreEstado String(50) Nombre del estado logístico “Admitida”
nombreCiudadOrigen String(50) Ciudad (junto con iniciales de departamento y país) del NEIVA\\HUIL\\COL
origen del envío
nombreCiudadDestino String(50) Ciudad (junto con iniciales de departamento y país) del BOGOTA\\CUND\\COL
destino del envío
idClienteCredito Integer Id del cliente que realiza la consulta y a la que 4288
pertenece la guía.
fechaConsulta DateTime Fecha y hora en la que se realiza la consulta del estado 2021-11-23T11:06:59.933
fechaEstado DateTime Fecha y hora del estado logístico reportado 2021-11-23T11:07:00.513
mensajeGuiasNoCliente String(255) Si se presenta, esta variable presentará el mensaje de null
excepción sobre la consulta de las guías. Principalmente
34
se presenta cuando alguna de las guías consultadas no
pertenece al cliente o no se encuentre admitida
listadoGuiasNoCliente Array Si se presenta, se mostrarían las guías que no null
pertenezcan al cliente.
Nota: En caso de alguna excepción o erro, devolverá un resultado nulo, indicando que la guía no existe o no se encuentra admitida.
16 CONSULTA DE ESTADOS SITIO “SIGUE TU ENVÍO”:

Descripción
Dirección URL para la consulta directa de una guía y redireccionar al resultado de la consulta “Sigue Tu Envío” en nuestro sitio web. La guía debe estar
Admitida para poder mostrar el resultado del estado en el que se encuentra la misma.
Método : URL
https://www.interrapidisimo.com/sigue-tu-envio/?guia=240000172994 (se coloca el número de guía admitida a ser consultada)
35
Nota: Por el momento, la URL anterior solo es funcional en ambiente productivo. Sin embargo, es posible usar la siguiente dirección como alternativa
en ambiente de pruebas:
https://stgwww3.interrapidisimo.com/ControllerWeb/Modulos/Transversal/ExploradorEnvios/Views/index.html?guia=240000172995
17 NOTIFICACIÓN DE ESTADOS (PUSH):

Funcionalidad alternativa utilizada para la notificación de estados de una guía (envío admitido).
⚫ El cliente deberá construir y proveer la dirección de una 1er API REST (tipo POST), usuario y contraseña para obtener el TOKEN de seguridad del API
que, posteriormente, se le enviará al PUSH (este proceso se repetirá por cada notificación de estado). Esta API debe contener los siguientes datos
en su estructura:
36
HEADERS:

Authorization String(250) Header de autorización Básica (Basic+espacio+usuario:contraseña Basic Zm9vOmJhcg==
suministrada por el cliente, codificada en base64)
Ejemplo Header 1ra API
BODY REQUEST:

grant_type String(250) Variable de validación de la conexión. "client_credentials"
Este tendrá un valor fijo.
validity_period String(250) Tiempo de validez del token generado "3600"
37
Ejemplo Body 1ra API
NOTA: El Response de este servicio, independientemente de las variable adicionales incluidas por el cliente, es indispensable que devuelva
el token en una variable llamada “access_token” (formato JSON), para que la 2da API pueda realizar el consumo del mismo. Ejemplo:
⚫ A continuación, el cliente deberá construir y proveer la dirección de una 2da API REST (tipo POST), habilitada para recibir PUSH. Por defecto, nuestro
proceso PUSH usará el token generado por el API anterior.
Nota: La 2da API del cliente debe reconocer como Header una variable "Authorization", la cual viajará con la siguiente estructura: "Bearer" + espacio +
Token (el generado por la API anterior).
HEADERS:
Nombre Tipo Dato Descripción Valor (Ejemplo)

Parámetro
Authorization String(250) Header de autorización (Bearer+espacio+token Bearer
generado por la 1ra API) 24Zm9vOmJhcglasfljlwfñoasfjlsofj<sajfljsfjlzfszjkfjilwjesriñepp==
38
El objeto estándar JSON (el que debe tomarse como referencia para construir el API desde el cliente) es el siguiente:

FechaNotificacion Fecha Fecha y hora de la notificación del estado “2020-01-17T18:00:00”
FechaEstado Datetime Fecha y hora del estado notificado. “2020-01-14T15:37:15.457”
NumeroGuia long Número de guía de la que se genera el estado 230001782692
DescripcionEstado String(25) Descripción estado logístico generado. Ver tabla tipos de Estado “Admitida”
(2. Conceptos Básicos de Consumo)
CodigoEstado integer Código estado logístico generado. Ver tabla tipos de Estado 1
(2. Conceptos Básicos de Consumo)
DescripcionMotivoEst String(25) Descripción motivo del estado logístico generado, cuando se

presente uno de los estados de excepción (tabla de motivos en
el Anexo 2)
CodigoMotivoEst integer Código de motivo estado logístico generado, cuando se

presente uno de los estados de excepción (tabla de motivos
en el Anexo 2).
39
CodigoCiudad String(8) Código DANE ciudad. “11001000”
Tabla 15 - Estructura JSON para notificaciones de estado (PUSH)
Ejemplo Header 2da API Ejemplo Body 2da API
40
18 SERVICIO RECOGIDAS:
Descripción
Funcionalidad opcional utilizada para programar, basado en una preselección de guías de envíos, una orden de recogida esporádica, según la
necesidad. Estas recogidas no afectan la programación de Recogidas fijas configurada para el cliente.
Método : POST
http://stgwww3.interrapidisimo.com/ApiVentaCreditoStg/api/Recogida/InsertarRecogidaCliente/
Header

x-app-signature String(250) Firma digital generada por el sistema (Inter userMiTiendaStg
Party)
Tabla 18 - Headers Request Servicio Recogidas
Request

IdClienteCredito Long Id de cliente asignado al momento de crearlo en el 6486
sistema de Inter Rapidídimo
IdSucursalCliente Long Id de sucursal creada en nuestros sistemas relacionado 27185
con el cliente.
listaNumPreenvios Array Arreglo de 1 o varias guías que estarán relacionadas con [240000031973,240000031974,240000031975,
240000031976]
la Recogida Esporádica solicitada
41
fechaRecogida DateTime Fecha y hora en la que se requiere la Recogida "2021-08-26T14:00:01.331Z"
esporádica, de acuerdo con el horario de la operación
para este tipo de solicitudes. En caso de que se solicite en
horarios fuera de la operación, arrojará un mensaje de
error con el mensaje correspondiente
Tabla 19 - Request Servicio Recogidas
Response

IdRecogida Integer Número de Recogida esporádica, generado por nuestros 4497406
sistemas
cantidadPreenvios Integer Cantidad de guías preadmitidas (preenvíos), relacionados en 3
la Recogida generada
fechaSolicitud Date Fecha y hora en la que se requiere la Recogida (la misma 2021-08-26T14:00:01.331Z
colocada en la entrada del servicio)
pesoTotal Float Sumatoria del peso de todos los envíos individuales, incluidos 4.0
en la Recogida esporádica.
mensajePreenviosAsociados String(100) Mensaje que indica cuando alguno de los preenvíos están “Alguno de los pre envíos ya tienen
una orden de Recogida. Favor
relacionados a otra Recogida previa. verificar.”
preenviosAsociados Array Se relacionan las guías preadmitidas (preenvíos) no [240000031973,240000031974]
relacionados en la solicitud. Esto solo aparece cuando se
intentan generar la orden de Recogida con guías relacionadas
con alguna Recogida previa.
mensajeCantidadMaximaPreenvios String(100) Mensaje que indica si se sobrepasa el límite máximo de guías “Cantidad de pre envíos sobrepasa
el máximo parametrizado. Favor
relacionadas a una misma Recogida. verificar o solicitar el cambio de
este límite en la transportadora”
preenviosNoIncluidos Array Se relacionan las guías preadmitidas (preenvíos) no [240000031973,240000031974]
relacionados en la solicitud. Esto solo aparece cuando se
sobrepasa el límite máximo de guías permitidas en una única
orden de Recogida esporádica.
Tabla 19 - Request Servicio ciudades
Ejemplo request y ejecución servicio Recogidas:
{
42
"IdClienteCredito": 6486,
"IdSucursalCliente": 27185,
"listaNumPreenvios": [240000031973,240000031974,240000031975,240000031976],
"fechaRecogida": "2021-08-26T14:00:01.331Z"
43
19 SERVICIO PLANILLA PREENVÍOS:
Descripción
Funcionalidad opcional utilizada para generar, como control para el cliente, un informe (en pdf) donde se pueda colocar la relación de guías
preadmitidas (PreEnvíos) a ser entregados al mensajero que realiza la Recogida de los envíos. Se dispuso como un control adicional de cara a la
operación del cliente.
Método : POST
http://stgwww3.interrapidisimo.com/ApiVentaCreditoStg/api/Planilla/GenerarPlanillaRecoleccionPreenvios
Header

x-app-signature String(250) Firma digital generada por el sistema (Inter d3e7fbf8835280e7e5d526ed438092d3
Party)
x-app-security_token String(250) Campo Access_token, retorno de servicio Ij^M>y!?f~jf%ft()Ujb¿|_VoX|yJDxlah<-q>/%m#x>BYAK}LN>UwRT**kFC`$
de autenticación.
Tabla 18 - Headers Request Servicio Planilla PreEnvíos
Request

idCliente Integer Id de cliente asignado al momento de crearlo en 6486
el sistema de Inter Rapidídimo
idSucursal Integer Id de sucursal creada en nuestros sistemas 27185
relacionado con el cliente.
44
listaNumPreenvios Array Se relacionan las guías preadmitidas (preenvíos) a [240000031973,240000031974,240000031975,
240000031976]
ser entregados al mensajero de la transportadora
que realizaría la recogida. Solo se deben
relacionar preenvíos generados a través de la API
(servicio) de Admisión de Preenvíos (prefijo 24).
Response

numeroPlanilla String(8) Consecutivo generado de forma automática del número de 2
planilla
fechaCreacion String (250) Fecha y hora de generación de la planilla 2021-08-31T14:53:43.3843195-
05:00
mensajeCantidaMaximaPreenvios String (250) Mensaje de advertencia que se muestra cuando se sobrepasa “La cantidad de pre envíos
excede el número máximo de
el número máximo parametrizado de preenvíos que se nnnn. Favor intente nuevamente
pueden generar para una misma planilla. con los pre envíos no incluidos.”
numerosPreenviosNoIncluidos Array Se muestra el arreglo de los preenvíos que sobrepasan el [240000031975]
número máximo de preenvios aceptados en un único
consumo.
mensajePreenviosInvalidos String (250) Mensaje de advertencia que indica que algunos de los “Alguno de estos pre envíos no
corresponden al cliente. Favor
números de guías preadmitidas (preenvíos) no son válidos o verificar los datos.”
no corresponden al cliente.
numerosPreenviosInvalidos Array Se muestra el arreglo de los preenvíos no válidos incluídos en [240000031973,240000031974]
la entrada del servicio. Básicamente serán aquellos que no
posean el prefijo 24 o que no correspondan a los generados
por el cliente.
arregloBytesPlanilla Base64 Planilla codificada en Base64, que contiene el formato de JVBERi0xLjUNCiWDkvr+DQoyNC
AwIG9iag0KPDwNCi9UeXBlIC9DY
planilla en pdf con los preenvíos relacionados en el consumo XRhbG9nDQovUGFnZXMgMjUgM
del servicio CBSDQovQWNyb0Zvcm0gMjYgM
CBSDQo+Pg0KZW5kb2JqDQozID
Agb2JqDQo8PA0KL0xlbmd0aDEg
MTg1ODQNCi9MZW5ndGggODU5
NA0KL0ZpbHRlciAvRmxhdGVEZW
NvZGUNCj4+DQpzdHJlYW0NCnic
7XoJeFNV3vc9N0nLVm1IF6AFbuk
O3dM03du0Tdu06ZakSReWZmuT
45
Nk1ClrbIDgUKIioj4AYIMioOCGpdq
AsOOuqjouPgjKOOM843r9voO9+
Msyk06fc/596kKaKf77zf+z3v+zwQ
b3LOuef8l99/..........
Ejemplo Request, Response y Planilla Preenvíos:
"idCliente": 6486,
"idSucursal": 27185,
"listaNumPreenvios": [240000031973,240000031974,240000031975,240000031976]
46
20 SERVICIO LOCALIDADES:
Descripción
Funcionalidad opcional utilizada para consultar, según sucursal de origen del envío, las ciudades que tenga configurada a las que puede realizar los
envíos como excepción (si no se parametrizan excepcciones, no traerá ningún valor)
Método : GET
https://stgwww3.interrapidisimo.com/ApiVentaCreditoStg/api/Localidades/ObtenerlocalidadesVentaCredito/{IdSucursal}
Header

47
x-app-signature String(250) Firma digital generada por el sistema (Inter d3e7fbf8835280e7e5d526ed438092d3
Party)
x-app-security_token String(250) Campo Access_token, retorno de servicio Ij^M>y!?f~jf%ft()Ujb¿|_VoX|yJDxlah<-q>/%m#x>BYAK}LN>UwRT**kFC`$
de autenticación.
Tabla 18 - Headers Request Servicio ciudades
Request

IdSucursal long Número de guía generado 15230
Response

IdLocalidad String(8) Número DANE de la localidad (ciudad) 11001000
NombreCompleto String (250) Nombre de ciudad - departamento - COL BOGOTA\\CUND\\COL
Ejemplo servicio Localidades:
48
49
Documentación Servicio Web API REST
Integraciones B2B
ANEXOS
Release 3.0
50
21 ANEXO 1 – MATRIZ DE ESTADOS LOGÍSTICOS
Id Estado Actual Observación
1 Envío Admitido EL envío se encuentra creado en sistema sin la recepción en centro logístico.
2 Ingresado A Bodega El envío ingresa a centro logístico bien sea de origen o de destino.
3 Viajando En Ruta Nacional El envío es despachado a destino dentro de un operativo nacional.
El envío es despachado a un destino aledaño o a municipio de la misma
4 Viajando En Ruta Regional
RACOL.
5 Para Reclamar en Oficina El envío se encuentra listo para ser reclamado en un punto de venta autorizado.
6 En Distribución Urbana El envío se encuentra en estado de reparto dentro de la zona asignada.
Cuando el intento de entrega es fallido, y el envío se encuentra en retorno a
7 En Proceso de Devolución
centro logístico.
8 En Confirmación Telefónica El envío se encuentra en telemercadeo para confirmación de información.
la entrega no es efectiva y el envío se encuentra en trayecto de devolución a su
10 Devuelto Al Remitente
origen.
11 Entrega Exitosa El envío esta entregado.
12 Para Nuevo Intento Entrega El envío es enviado nuevamente a distribución por intento fallido.
13 Prueba de Entrega Digitalizada Indica que el soporte de la entrega se encuentra habilitado en el sistema.
14 En Investigación El envío presenta un siniestro y se escala a nivel de investigación operacional.
15 Documento Anulada La guía generada es anulada del sistema.
La prueba de entrega esta dentro del archivo central de operaciones como
16 Prueba de Entrega Archivada
expediente de consulta.
51
El estado del envío que despues de un tiempo no es reclamado por remitente y
17 Disposición Final
destinatario y procede a proceso de destrucción o donación.
El envío se encuentra despachado del centro logístico al punto de venta
18 Despachado Para Bodega
solicitado.
El envío a sido retenido por las autoridades y se encuentra en proceso de
21 Incautado Por Autoridades
inspección.
El envío que no se puede entregar en diferentes intentos de entrega o es
22 Para Bodega Final/Custodia rehusado por el destinatario debe pasar al área de custodia para su
disposisición.
Estado del envío que impone el cliente corporativo cuando exsite una
23 No Llego el Envío Físico
discrepancia entre las guías generadas y el envío fisico.
Estado aplica para aquellos envíos que sin gestión de origen o destino, parsado
25 Facturado
el corte de facturación son incluidos dentrode la liquidación.
Estado que genera el proceso de control de cuentas cuando se debe realizar
26 Nota Crédito una repossión financiera al cliente por una desviación en la liquidación de su
factura.
Estado que indica que el envío está asignado a un auditor en terreno que
29 En Auditoria en Terreno
verifica la información errada por la cual no se entrego.
Devolución por Confirmación del Estado que indica que el cliente de origen confirma por telemercadeo que se
30
Cliente debe hacer efectiva la devolución del envío.
31 En Distribucion Urbana Agencia Envío se encuentra asignado para reparto en municipio o ciudad aledaña.
Estado del envío cuando se encuentra en centro logistico de destino y será
32 Para devolver al Remitente
próximo a despachar a origen.
Envíos se encuentra en bodega de custiodio en estado de espera de
9 En Bodega Final/Custodia
reclamación o confirmación de datos.
52
22 ANEXO 2 – MOTIVOS DE DEVOLUCIÓN
Identificador Descripción
1 OTROS / ACCIDENTE
2 REHUSADO / AVERIADO
3 NO RESIDE / CAMBIO DE DOMICILIO
4 DESCONOCIDO / DESTINATARIO DESCONOCIDO
5 DIRECCION ERRADA / DIRECCION INCOMPLETA
6 DIRECCION ERRADA / DIRECCION NO EXISTE
7 OTROS / VACACIONES
8 NO RESIDE / INMUEBLE DESHABITADO
9 REHUSADO / SE NEGO A RECIBIR
10 DIFICULTAD DE PAGO AL COBRO
11 OTROS / NO PAGARON EL ALCOBRO
12 NO RESIDE / FALLECIDO
13 OTROS / HUELGA
14 OTROS / CERRADO ANTES DE LAS 6PM
15 OTROS / RESIDENTE AUSENTE / NO ALCANZO EL MENSAJERO
16 OTROS / VISITA FUERA DE HORARIO
17 OTROS / RETENCION EN DEVOLUCION
53
18 OTROS / TROCADO
19 OTROS / N0 LABORAN LOS SABADOS
20 OTROS / PETICION DEL REMITENTE
21 REHUSADO / HURTO
22 OTROS / INCAUTADO
23 OTROS / PARA RECLAMO EN OFICINA
24 OTROS / RESIDENTE AUSENTE 1 AVISO
26 REHUSADO / CONTENIDO INCOMPLETO
33 OTROS / ACCIDENTE
39 DEV. EN VACACIONES
54
44 OTROS / HUELGA
45 OTROS / TROCADO
47 REHUSADO / HURTO
49 OTROS / NO RECLAMO EN OFICINA
51 REHUSADO / CONTENIDO INCOMPLETO
52 DESTRUCCION
53 DONACION
54 VENTA INTERNA
55 REHUSADO / HURTO
56 DIFICULTAD DE PAGO AL COBRO
63 OTROS / RESIDENTE AUSENTE TELEMERCADEO
55
108 OTROS / RETENCION EN DEVOLUCION
111 OTROS / RESIDENTE AUSENTE
113 OTROS / BLOQUEO DE CALLES
114 OTROS / FUERA DE ZONA
115 OTROS / NO PAGARON PRODUCTO CONTRAPAGO
116 OTROS / FUERA DE ZONA
117 OTROS / ACCIDENTE
119 OTROS / HUELGA
122 OTROS / RESIDENTE AUSENTE / NO ALCANZO EL MENSAJERO
128 DIRECCION ERRADA / NO CORRESPONDE LA CIUDAD DESTINO
56
132 REHUSADO / CONTENIDO INCOMPLETO (HURTO)
133 REHUSADO / NO PAGARON EL ALCOBRO
134 REHUSADO / NO PAGARON PRODUCTO CONTRAPAGO
136 OTROS / CAMBIAR NUEVA DIRECCION DE ENTREGA
137 OTROS / A PETICION DEL REMITENTE
139 OTROS / HURTO
140 OTROS / ENVIO CRUZADO (TROCADO)
141 OTROS / NO MARCADO NO IDENTIFICADO (NN)
142 OTROS / A PETICION DEL REMITENTE
143 OTROS / NO RECLAMADO EN OFICINA
150 DIRECCION ERRADA / NO CORRESPONDE LA CIUDAD DESTINO
153 REHUSADO / NO PAGARON EL ALCOBRO
154 OTROS / CAMBIAR NUEVA DIRECCION DE ENTREGA
57
156 REHUSADO / CONTENIDO INCOMPLETO (HURTO)
157 REHUSADO / NO PAGARON PRODUCTO CONTRAPAGO
160 OTROS / HURTO
163 OTROS / HUELGA
165 OTROS / ENVIO CRUZADO (TROCADO)
167 INGRESO A CUSTODIA
168 OTROS/ DEVOLUCION EN ESPÉRA CONFIRMACION CLIENTE
169 ACCIDENTE
170 BLOQUEO DE CALLES / CRUDO INVIERNO / MANIFESTACION / ORDEN
171 HUELGA
172 VACACIONES
173 RESIDENTE AUSENTE
175 NO RESIDE - INMUEBLE DESHABITADO
176 NO RESIDE - CAMBIO DE DOMICILIO
177 NO RESIDE - FALLECIDO
178 DIRECCION ERRADA - DIRECCION INCOMPLETA
179 DIRECCION ERRADA - DIRECCION NO EXISTE
180 DIRECCION ERRADA - NO CORRESPONDE LA CIUDAD DESTINO
181 DESCONOCIDO - DESTINATARIO DESCONOCIDO
182 REHUSADO - SE NEGO A RECIBIR
58
183 REHUSADO - AVERIDADO
184 REHUSADO - CONTENIDO INCOMPLETO (HURTO)
185 REHUSADO - NO PAGARON AL COBRO
186 REHUSADO - NO PAGARON PRODUCTO CONTRAPAGO
187 NO RECLAMADO EN OFICINA
188 CAMBIAR NUEVA DIRECCION DE ENTREGA
189 A PETICION DEL REMITENTE
190 INCAUTADO
191 HURTO
192 ENVIO CRUZADO - TROCADO
193 ENTREGA MAESTRA
194 OTROS / CONTENIDO NO CORRESPONDE
195 OTROS / CONTENIDO NO CORRESPONDE
196 OTROS / REVISIÓN POR AUTORIDADES
197 OTROS / REVISIÓN POR AUTORIDADES
198 EL CLIENTE YA NO REALIZA EL ENVIO
199 MALA CAPTURA DE INFORMACION EN SISTEMA
200 CONFIRMACION DE AUDITORIA
201 CONFIRMACION DE CIERRE
202 MALA IMPORTACION BASE DE DATOS
203 ENMENDADURAS
204 DOBLE MARCA EN LA FORMA DE PAGO
205 REPORTADA ANULAR ESTA EN LIMPIO
206 OTROS / CRUDO INVIERNO
59
207 OTROS / MANIFESTACION ORDEN PUBLICO
208 OTROS / CRUDO INVIERNO
209 OTROS / MANIFESTACION ORDEN PUBLICO
23 ANEXO 3 – EJEMPLOS CÓDIGO CURL DE LOS SERVICIOS
COTIZADOR:
curl --location --
request GET 'https://stgwww3.interrapidisimo.com/ApiServInterStg/api/Cotizadorcliente/ResultadoListaCotizar/4261
/11001000/52835000/1/59900/1/09-08-2021' \
--header 'x-app-signature: userWxyzstg' \
--header 'x-app-security_token: bearer I1hnZBkEvVd_Xocb_IT-Af7xAWtNFIARHwBapcrA3sJ-
gE3AO2MN8qPkLh26Xvm0EhCkiClg3ihCNmf5aTfTb9VdxLMyt1LL7zyPoMVOqXervGHSK8Ir9ynFJlkDatC6298vnOudi0djjWHE2By7sXXiX1C5
uftwc6UbewEia0IfFpAN1FzNT5j9oWIpQFurKrMIpwh5JXdIU5RYsyvGBUyU__7WNa-iQjHrRP3VUJgPlRMSRAtLCwvr2OF5KHeS'
ADMISION PRE ENVIOS:
curl --location --
request POST 'http://stgwww3.interrapidisimo.com/ApiVentaCreditoStg/api/Admision/InsertarAdmision/' \
--header 'x-app-signature: UserWxyzSTG' \
--header 'x-app-
security_token: bearer jlvzerBt2kL78OJKhP7z5yc6d0wvLpe1tv9ZLfrjZTBRaFrme50xpI7GNPcPZVBdsvH68kWyJJK63XV-
jTXxbukjdcyHH0S0QCzbHBL37_UbmBputuc7OUn8M_ErHBOoL3DCQqQJC1Z89aT-sm5G-
yoMIJJnu2Mtdy_pcmtIasOY9jcbAtwi5VLjeM_iMAfQP5M5HgjSSzAmMFeti32XFbanedy8lrHpHCsh5x4EDYGo-7kqLJzubxWsIU82-O8x' \
--header 'Content-Type: application/json' \
--data-raw '{
60
"IdClienteCredito":1234, //Codigo cliente
"CodigoConvenioRemitente": 123456, //Codigo sucursal
"IdTipoEntrega":"1",
"AplicaContrapago": "False",
"IdServicio":3,
"Peso":1, //En kilogramos
"Largo":1, //En centimetros
"Ancho":1,
"Alto":1,
"DiceContener":"Prueba",
"ValorDeclarado":59000,
"IdTipoEnvio":1,
"IdFormaPago":2,
"NumeroPieza":1,
"Destinatario":{
"tipoDocumento":"CC",
"numeroDocumento":"123456789",
"nombre":"Juan",
"primerApellido":"Perez", //Si se debe enviar si es un cliente persona natural, es obligatorio
"segundoApellido":null,
"telefono":"3012884943",
"direccion":"CARRERA 79 # 19 - 88",
"idDestinatario":0, "idRemitente":0, //Campos opcionales. Dejarlos en 0
61
"idLocalidad":"11001000", //Codigo DANE ciudad destinatario
"ConvenioDestinatario":0, //Enviar valor 0 si no es cliente convenio
"correo":"nada@gmail.com" //Obligatorio si es cliente convenio
},
"DescripcionTipoEntrega":"",
"NombreTipoEnvio":"CAJA",
"IdSucursal":0, //Enviar valor 0 si no es cliente convenio
"IdCliente":0, //Enviar valor 0 si no es cliente convenio
"Notificacion":null,
"RapiRadicado":null,
"Observaciones":"Prueba"
}'
GENERACION FORMATO GUIA:
curl --location --
request GET 'https://stgwww3.interrapidisimo.com/ApiVentaCreditostg/api/Admision/ObtenerBase64PdfPreGuia/2400000
00001' \
62
--header 'x-app-signature: userWxyzStg' \
--header 'x-app-security_token: Bearer T4kj8EIfOoxt5CgjrD34XTQmC2W2m1EhIkN6pdyxEJW41FUM1ujAJ4O1QLcAsQkxTQ6pV5G-
JWX0Vuvf0JnU3EGLjJAdP2KDaR7WVGqPfqXwP2yCkIcPzFQ-hxjsBKflC87idom-brMxK84kUBUOqLSFWJ7fOm6xQ-
gUUQA9Pg6S7pZXWA98CBzKegrqv-2g0cUzJAP4gTHiLcw-iZH887ZL2Z3fH4x2OrnueDN3BmNKYBS3h4AHzPCLW5w7xNif'
GENERACION GUIAS POR LOTE:
curl --location --
request POST 'https://stgwww3.interrapidisimo.com/ApiVentaCreditostg/api/Admision/ObtenerBase64PdfPreGuias/' \
--header 'x-app-signature: userWxyzProd' \
--header 'x-app-security_token: Bearer 2muj2jPReDvw5l_4PWQ2UqA7yuhKpoRnrFXdMYhfFJ1TXXR2RZXTZUKpJMVrPph0gW-
touxub2XTdHXimSk9Emnm5sQgqSQc--
r3dXsZNokkzpFQTYyPPYT4FVSsJnf6VaZCrWmUg25SkPDYr2IZNt_WiOeDBB5YRbtoVvGLpsId5M8DbQuPF2oJipSG0mHydMBbzEUAZWpb3FW9jV
_pA8Vm9BTNCI8iuSgpD8udiwLD5Ep7rT_ahhR3-nughrbM' \
--data-raw '{
"IdCliente": 1234,
"IdSucursal": 12345,
"PorRangoFecha":true,
"LTSPREGUIAS":[240000000001, 240000000002,240000000003,240000000004],
"FechaInicio":"2021-08-10T00:01",
"FechaFinal":"2021-08-12T23:59"
}'
63
CONSULTA ESTADO GUIAS (tracking):
curl --location --
request POST 'https://stgwww3.interrapidisimo.com/ApiVentaCreditoSTG/api/ClientesCredito/ConsultarEstadosGuiasCl
iente' \
--header 'x-app-signature: UserWxyzSTG' \
--header 'x-app-
security_token: bearer jlvzerBt2kL78OJKhP7z5yc6d0wvLpe1tv9ZLfrjZTBRaFrme50xpI7GNPcPZVBdsvH68kWyJJK63XV-
jTXxbukjdcyHH0S0QCzbHBL37_UbmBputuc7OUn8M_ErHBOoL3DCQqQJC1Z89aT-sm5G-
yoMIJJnu2Mtdy_pcmtIasOY9jcbAtwi5VLjeM_iMAfQP5M5HgjSSzAmMFeti32XFbanedy8lrHpHCsh5x4EDYGo-7kqLJzubxWsIU82-O8x' \
--data-raw '{
"idCliente": 1234,
"numeroGuias": [240000000001]
}'
RECOGIDAS:
curl --location --
request POST 'http://stgwww3.interrapidisimo.com/ApiVentaCreditoStg/api/Recogida/InsertarRecogidaCliente/' \
--header 'x-app-signature: userWxyzStg' \
--header 'x-app-security_token: Bearer p1_mr2KmHkE8l003U4YgrETG_0tuwguKn64FtUcMmymZ0C0fziWLaUgCgB9uK_VU7byR-
zsJnRAsevV1x3efLuy3n0KR4-962P9AElcijiKiCAq9dzzOEPW4rrN6vFZcH5fcJQU4DNao3qh6Agzkj-LEtuegTiaRRlH_TnWsZrzmab-
OXzRYH2d3Zm74vbo3uw3iksm623wsmJnFcPFRCaiZvlGroIl2TwSYedyUuhzV6u1fkiV96MEySwQ978TL' \
64
--data-raw '{
"IdClienteCredito": 1234,
"IdSucursalCliente": 12345,
"listaNumPreenvios": [ 240000004408],
"fechaRecogida": "2021-09-29T15:55:14.885Z",
}'
PLANILLA PRE ENVIOS:
curl --location --
request POST 'http://stgwww3.interrapidisimo.com/ApiVentaCreditoStg/api/Planilla/GenerarPlanillaRecoleccionPreen
vios' \
--header 'x-app-signature: userWxyzProd' \
--header 'x-app-
security_token: bearer ZFkz1QMtGu481I15UIku848cXJgh65GZ0qotvRNCufFfh9njXCFXC0cuM8VqemGgW0c98if7_KOAikgV1N-
LxnqKko0j1VtGaYLCrmr3wgEL7tnDlGRKmlzJ-m3M-7fZd4qUn6oPK65qvN84ecjUolkjvqI7T4hVO4Zqx_uEnCZQf5jWobfFqi3mcUNtu-
y7o7CkcNVPIrUjCe1mxhngThGUCTJtbSICcCk-uzAbBLA8_GS0xmjnlzZYdNAtBm6Z' \
--data-raw '{
"idCliente": 1234,
"idSucursal": 12345,
"listaNumPreenvios": [240000031973,240000031974,240000031975,240000031976]
}'
65

Documentacion API INTERRAPIDISIMO

Cargado por

Información del documento

Descripción original:

Derechos de autor

Formatos disponibles

Compartir este documento

Compartir o incrustar documentos

Opciones para compartir

¿Le pareció útil este documento?

¿Este contenido es inapropiado?

Copyright:

Formatos disponibles

Documentacion API INTERRAPIDISIMO

Cargado por

Copyright:

Formatos disponibles

Documentación Servicio Web API REST

Ultima Actualización: Abril 2022

Fecha Detalle del Cambio Autor

2021-03-24 Adición tablas descriptivas adicionales José Manuel Sánchez J.

2021-03-26 Adición descripción Notificación de Estados (PUSH) Alfredo Antonio De Castro G.

2021-04-19 Inclusión nuevas APIs construídas José Manuel Sánchez J.

Documentación B2B API REST – Release 3.0

Documentación B2B API REST – Release 3.0

Documentación B2B API REST – Release 3.0

6 OVERVIEW FLUJO BÁSICO INTEGRACIÓN (BPMN)

Ilustración 1 - Overview Flujo Básico Consumo Servicios Integración

Documentación B2B API REST – Release 3.0

URL Recurso Descripción Ambiente

https://stgwww3.interrapidisimo.com/ApiVentaCreditostg / URL Servicio Admisión de Pre Pruebas

https://stgwww3.interrapidisimo.com/ApiVentaCreditostg /api/ClientesCredito/Consulta URL Servicio para consulta Pruebas

https://www.interrapidisimo.com /sigue-tu-envio/?guia= URL para consulta de estado Producción

https://stgwww3.interrapidisimo.com/ApiVentaCreditostg /api/Admision/ObtenerBase6 URL servicio Consulta Guía Pruebas

https://stgwww3.interrapidisimo.com/ApiVentaCreditostg /Localidades/Obtenerlocalida URL servicio Localidades Pruebas

https://stgwww3.interrapidisimo.com/ApiVentaCreditoStg /api/Recogida/InsertarRecogi URL servicio Recogidas Pruebas

https://stgwww3.interrapidisimo.com/ApiVentaCreditoStg /api/Planilla/GenerarPlanillaR URL servicio planilla Pruebas

Tabla 1 - Datos Básicos (URL) Consumo APIs

Documentación B2B API REST – Release 3.0

Valor Nombre Descripción

Tabla 2 – Forma de Pago

Estados de la Guía (Integer)

Valor Nombre Descripción

Documentación B2B API REST – Release 3.0

Valor Nombre Descripción

1 ENTREGA EN DIRECCION Entrega en la dirección solicitada (Ciudad o municipio)

Tabla 4 - Tipos de Entrega

Tipo de Envío (Integer)

1 SOBRE CARTA 0.0000 10.000

2 SOBRE MANILA 0.0000 20.000

3 PAQUETE PEQUEÑO 0.0000 20.000

4 TULA 0.0000 1.000.000

5 CAJA PEQUEÑA 40.000 50.000

6 OTROS 60.000 7.000.000

7 BULTO 60.000 7.000.000

9 PAQUETE 30.000 3.000.000

10 CAJA 60.000 1.200.000

Tipo de Identificación (Integer)

Documentación B2B API REST – Release 3.0

Identificación Servicio (Integer)

Valor Nombre Descripción

1 Rapi Hoy Rapi hoy mensajeria Puerta a Puerta

2 Rapi AM Rapi AM mensajeria Puerta a Puerta

3 Mensajería Mensajería Puerta a Puerta

4 Rapi Masivos Rapi Masivos

5 Rapi Promocional Rapi Promocional

6 Rapi Carga Terrestre Rapi Carga Puerta a Puerta

7 Rapi Carga Contrapago Rapi Carga Contrapago

9 Inter Viajes Inter Viajes

11 Internacional Descripción Servicio Internacional

12 Centros de Correspon. Centros de Correspondencia

Documentación B2B API REST – Release 3.0

14 Rapi Envíos Contrapago Rapi Envíos Contrapago

15 Notificaciones Notificaciones Judiciales

16 Rapi Radicado Carta Porte/Rapi Radicado

17 Rapi Carga Carga Express Puerta a Puerta

19 Rapi Tula Rapi Tula

20 Rapi Valores Msj Rapi Valores Mensajeria

21 Rapi Valores Carga Rapi Valores Carga

22 Rapi Carga Consolidada Rapi Carga Consolidada