API Pedido Rastreo

Descripción: Esta API permite la sincronizacion de sucursales entre SERPI y la plataforma que lo requiera permitiendo tener un manejo estandar entre las dos herramientas.

Autorización: Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authorization utilizando el token de acceso entregado SERPI ERP.

Beneficio:

Tipos de peticiones: GET, POST, PUT

¿Cómo funciona?

• Tenga en cuenta que un mismo token no puede ser consumidos de manera simultanea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.
• En términos de tiempo, para hacer seguimiento a su operación puede hacer un consumo cada 5 minutos de la información.

Métodos

<Tabs> <Tab name = "API Consulta Tipo Documento (GET) "> GET/users

EndPoint: https://www.apis.serpi.com.co/api/v1/PedidoVenta/GetTipoDocumento

Headers

Header	Descripción
secretkey	Secretkey proporcionada al cliente para consumos de las APIs

Authorization:

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Parámetros

Parámetro	Tipo de dato	Requerido	Descripción
Límite	int	No	Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
Página	int	No	Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página

Response

{
    "success": true,
    "code": 200,
    "errors": null,
    "message": "2 registro(s) encontrados",
    "result": [
        {
            "id": 1,
            "categoriaDocumento": "PDV",
            "prefijo": "PDV",
            "descripcion": "PEDIDO VENTA"
        }
    ]
}

{
    "success": true,
    "code": 204,
    "message": "No se encontraron registros",
}

Campo de resultados

Campo	Tipo de dato	Descripción
id	int	Corresponde al id del tipo de documento
categoriaDocumento	String	Categoria del tipo de documento
prefijo	String	Prefijo del tipo de documento
descripcion	String	Descripcion del tipo de documento

</Tab>

<Tab name = "API Consulta Pedido Rastreo (GET) "> POST /users

EndPoint: https://www.apis.serpi.com.co/api/v1/PedidoVenta/RastreoPedido?idTipoDocumento=15&numero=55

Headers

Header	Descripción
secretkey	Secretkey proporcionada al cliente para consumos de las APIs

Parametros

Campo	Tipo	Requerido	Descripción
idTipoDocumento	Int	SI	Id del tipo de documento (Api consulta tipo de documento)
numero	Int	SI	Numero de pedido a consultar

Authorization:

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Request

{
    "success": true,
    "code": 200,
    "errors": null,
    "message": "1 registro(s) encontrados",
    "result": [
        {
            "prefijoPedido": "PDV",
            "numeroPedido": 2,
            "facturas": [
                {
                    "prefijoFactura": “FV”,
                    "numeroFactura": 3,
                    "fechaFactura": "2023-04-18",
                    "estadoFactura": “En Alistamiento”,
                    "transportador": “Servientrega”,
                    "nroGuia": “G00002348232323”
                },
   {
                    "prefijoFactura": “FV”,
                    "numeroFactura": 4,
                    "fechaFactura": "2023-04-18",
                    "estadoFactura": “En Alistamiento”,
                    "transportador": “Servientrega”,
                    "nroGuia": “G00002348232323”
                }
        }
    ]
}



{
    "success": true,
    "code": 204,
    "message": "No se encontraron registros",
}

Campos del request

Campo	Tipo de dato	Longitud	Requerido	Descripción
id_tercero	int	50	SI	Corresponde al identificador del tercero
nit_tercero	int	50	SI	Nit del tercero
codigo	string	50	SI	Codigo de la sucursal
referencia_sucursal	string	50	SI	Referencia de la sucursal
descripcion	string	50	SI	Descripcion de la sucursal
direccion	string	50	SI	Direccion de la sucursal
direccion2	string	50	NO	Segunda direccion de la sucursal
telefono	int	50	SI	Telefono correspondiente a la sucursal
telefono2	int	50	NO	Segundo telefono correspondiente a la sucursal
ext	int	50	NO	Extension de la sucursal
ext2	int	50	NO	Extension de la sucursal
movil	int	50	NO	Celular de la sucursal
id_ciudad	int	50	SI	Identificador correspondiente a la ciudad de la sucursal
codigo_ciudad	string	50	SI	Codigo de la ciudad de la sucursal
id_departamento	int	50	SI	Identificador correspondiente al departamento de la sucursal
codigo_departamento	string	50	SI	Codigo del departamento de la sucursal
id_pais	int	50	SI	Identificador correspondiente al pais de la sucursal
codigo_pais	string	50	SI	Codigo del pais de la sucursal
id_vendedor	int	50	SI	Identificador correspondiente al vendedor de la sucursal
id_cobrador	int	50	NO	Identificador correspondiente al cobrador de la sucursal
es_direccionCobro	bool	X	SI	Valida si es direccion de cobro
es_direccionDespacho	bool	X	SI	Valida si es direccion de despacho

Authorization:

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Response

{
    "success": true,
    "code": 201,
    "errors": null,
    "message": "registro creado exitosamente"
}

{
	"success": true
	"code": 201,
	"message": "No se encontraron registros",
	"result": []
}

</Tab>