1. manual orden de pedido - web servicesbi.sicom.gov.co/sicomservices/documents/sicom web services...
TRANSCRIPT
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
1. OBJETIVO Describir el funcionamiento del Web Services para las transacciones realizadas por los Agentes de la Cadena por medio de las Ordenes de Pedido.
2. ALCANCE
Aplica para los Usuarios del Web Services.
3. DEFINICIONES
Almacenador: Toda persona natural o jurídica dedicada a ejercer la actividad de almacenamiento de combustibles líquidos derivados del petróleo, en los términos de los Artículos 2.2.1.1.2.2.3.81 y 2.2.1.1.2.2.3.82 del presente Decreto. (Decreto 4299 de 2005, art. 4°) Despacho: Salidas físicas de combustibles líquidos, alcohol carburante y biodiesel, de la instalación del agente. Distribuidor Mayorista: Toda persona natural o jurídica dedicada a ejercer la distribución de combustibles líquidos derivados del petróleo, a través de una planta de abastecimiento conforme a lo señalado en el Artículo 2.2.1.1.2.2.3.83 y siguientes del presente Decreto. (Decreto 4299 de 2005, art. 4°, modificado por el Decreto 1333 de 2007, art. 2°) Estado de la Orden de Pedido: Muestra la etapa en la cual se encuentra la orden de pedido. Se clasifica en las siguientes:
- Solicitada: Registro de la orden de pedido realizada por el Agente comprador - Aceptada: Registro de la orden de despacho realizada por el Agente vendedor - Despachada: Registro de la salida de un producto de las instalaciones de la planta de
abastecimiento por orden del agente vendedor. - Cerrada: Registro de la verificación de los productos recibidos por el agente
comprador. - Rechazada: Registro de la inconformidad de los productos recibidos por el agente
comprador.
Importador: Toda persona natural o jurídica que ejerce la actividad de importación de combustibles líquidos derivados del petróleo, conforme a lo establecido en el artículo 2.2.1.1.2.2.3.77. y siguientes del presente Decreto. (Decreto 4299 de 2005, art. 4°)
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
Orden de Pedido: Mecanismo por el cual un Agente comprador solicita producto a través del SICOM a un Agente Vendedor. La Orden de Pedido indica los datos de la compra de combustibles a través del sistema como: el Agente comprador, el Agente vendedor, la Planta de Abastecimiento que va a despachar, el transporte a utilizar, productos, numero de guía, factura y volúmenes a comprar, entre otros. Planta de Abastecimiento: Son las instalaciones físicas, construidas y operadas en tierra, necesarias para almacenar, manejar y despachar al por mayor combustibles líquidos derivados del petróleo a la(s) planta(s) de otro(s) Distribuidor(es) Mayorista(s), a Distribuidores Minoristas o al Gran Consumidor. (Decreto 4299 de 2005, art. 4°) Refinador: Toda persona natural o jurídica que ejerce la actividad de refinación de hidrocarburos para la producción de combustibles líquidos derivados del petróleo, en los términos del artículo 2.2.1.1.2.2.3.75. y siguientes del presente Decreto. (Decreto 4299 de 2005, art. 4°) Web Services: designa una tecnología que permite que las aplicaciones se comuniquen en una forma que no depende de la plataforma ni del lenguaje de programación. Un servicio web es una interfaz de software que describe un conjunto de operaciones a las cuales se puede acceder por la red a través de mensajería XML estandarizada. Usa protocolos basados en el lenguaje XML con el objetivo de describir una operación para ejecutar o datos para intercambiar con otro servicio web. Un grupo de servicios web que interactúa de esa forma define la aplicación de un servicio web específico en una Arquitectura orientada a servicios (SOA).
4. DESARROLLO
4.1 GENERALIDADES
El uso de los Web Services es una solución viable y segura para el intercambio de información a través de internet, y las ventajas que ofrecen las nuevas tecnologías hacen de estos servicios un método de comunicación muy eficiente y a la vez, fácil de implementar. Los Webservices pueden ser accedidos desde un amplio número de Clientes (desde navegadores usando JavaScript, hasta aplicaciones nativas en cualquier dispositivo/plataforma). Uno de los usos principales es permitir la comunicación entre las empresas, y entre las empresas y sus clientes. Permiten además a las organizaciones intercambiar datos sin necesidad de conocer los detalles de sus respectivos Sistemas de Información.
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
La nueva versión propuesta del Sistema de Información de Combustibles Líquidos (SICOM) para sus Webservices, es una nueva y mejorada Arquitectura de Software, desarrollándose una forma de comunicación e intercambio de datos sencilla, escalable y segura, a través de OData (Open Data Protocol) y el consumo de RESTful APIs, y utilizando nuevas tecnologías más robustas de comunicación a través de internet, con compatibilidad con todos los nuevos dispositivos y aplicaciones, exponiendo la información en forma rápida y simple, soportando acciones CRUD basado en convenciones existentes, ya que trabaja con verbos HTTP GET, POST, PUT y DELETE. Además SICOM-Webservices V2.2 garantiza solucionar varias deficiencias de la versión anterior.
El sistema SICOM provee servicios para facilitar el intercambio de información con los sistemas de los diferentes roles de Agentes de la Cadena.
Los servicios publicados permiten acceder a la información de:
a) Órdenes de Pedido Simples creadas por los Agentes Compradores (EDS, Comercializador Industrial) en el sistema SICOM y que podrán consultar los Proveedores para la sincronización son sus sistemas internos.
b) Los Proveedores podrán modificar las órdenes de pedidos anteriores para “Aceptar” o “Rechazar” cada orden de pedido específicamente,
c) O por el contrario podrá “Despachar” cada una de estas Órdenes de Pedido. d) Los Agentes Compradores antes de ser aceptada su Orden de Pedido, podrán
“Anular” dichas Órdenes en cualquier momento, e) O después recibir el pedido podrán “Cerrar” cada Orden de Pedido respectivamente. f) Los Proveedores podrán consultar las Orden de Pedido Anuladas por los
Compradores. g) Los Compradores podrán consular las Orden de Pedido Rechazadas por los
Proveedores. Los Agentes que deseen utilizar los servicios web se SICOM, deberán:
1. Indicar en SICOM que usará WS, esto se realiza a través de la Opción de Datos
Generales. a) En donde se configuran varios datos tales como: IPs de servidores, Password WS
(Utilizado como método de validación para los consumidores de los servicios), etc. 2. Manejar listado de códigos establecidos por SICOM. (Ver Anexos)
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
Acceso a los servicios Web de SICOM:
URL: https://wss.sicom.gov.co/sicomdata/
https://wss.sicom.gov.co/ (Sitio Web informativo) Acceso a los servicios Web de SICOM en el ambiente de Calidad/Pruebas:
URL: http://wsp.sicom.gov.co/sicomdata/ Ventajas del servicio Web
Simplifica el intercambio de información entre los Agentes de la Cadena de Distribución de combustibles líquidos.
Disminución de errores por la reducción de los procesos manuales. Mayor seguridad en los procesos de compras y ventas. Comunicación e intercambio de información entre aplicaciones de forma estándar
a través de protocolos comunes (http) con independencia del lenguaje de programación, plataforma de implantación, y sistema operativo.
Un solo servicio para todos nuestros usuarios, un solo estándar de comunicación e intercambio de información, un solo soporte, un solo mantenimiento.
Protocolo OData estándar, nos permite la creación y consumo de APIs REST, permitiendo que los recursos identificados mediante direcciones URL y definido en un modelo de datos, serán publicados y actualizados en forma segura, por los Clientes Web que utilizan mensajes HTTP simples.
Compatibilidad con todos los nuevos dispositivos y aplicaciones, exponiendo la información en forma rápida y simple, soportando acciones CRUD basado en convenciones existentes, ya que trabaja con verbos HTTP GET, POST, PUT y DELETE.
Mayor nivel de seguridad con una arquitectura multicapas que protege las reglas de negocio y asila completamente la información.
Comunicación asincrónica, es una de las tecnologías preferidas por su eficiencia, especialmente con diferentes componentes de hardware. La principal ventaja de esta tecnología es la capacidad de transferir muchos tipos diferentes de datos al mismo tiempo. Esto es porque todo el ancho de banda se utiliza, siempre y cuando esté disponible. La codificación de datos en el modo de transferencia asíncrona es notablemente consistente. Esto ayuda durante el procesamiento de los datos, ya que no hay necesidad de estar atento del inicio y fin de la transmisión y cuenta con un mecanismo automático de recuperación ante fallas.
Múltiples conexiones en una sola puerta de enlace, estandarizando los parámetros de comunicación y seguridad.
Posibilidad de procesamiento de información en lotes, permitiendo múltiples paquetes de información en un solo intercambio.
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
El uso de log de errores y recuperación ante errores en las transacciones favorecerá la estabilidad del sistema, calidad y su mantenimiento general.
Fácil extensibilidad de los servicios. 1. Servicios Publicados
1.1 Autenticación y Autorización
Para acceder a los servicios publicados se debe autenticar en cada solicitud, la autenticación es HTTP básica, a través de un usuario y contraseña que emite SICOM a cada Cliente y que se utilizará para establecer cada conexión por protocolo https seguro, garantizando la validación del Cliente para el acceso a la información:
i. Se verifica la identificación del Cliente proporcionada por SICOM. ii. Se verifica el número IP de solicitud del Cliente. iii. Se registra cada acción realizada por el Cliente a partir del momento en que se
realiza la autorización. iv. Se garantiza el uso del certificado de seguridad sobre el protocolo HTTPS para el
Ambiente de Producción. La “Autenticación HTTP Básica”:
En pocas palabras, la autenticación básica indica que la solicitud está pasando el nombre de usuario y contraseña en el encabezado de solicitud HTTP. Todo lo que debe hacer es:
1) Crear una cadena con nombre de usuario y contraseña en el formulario de
"usuario:contraseña", 2) Convertir esa cadena a una cadena base64, 3) Anteponer la palabra "Basic" y un espacio más la cadena base64 anterior, 4) Y por último agregar al encabezado de la solicitud HTTP la autorización con la
cadena resultante. Ejemplo de encabezado: Authorization: Basic anNtaXRoOlBvcGNvcm4=
1.2 Consultar órdenes de pedidos simples creadas por los Agentes Compradores
Disponible para: Agentes Proveedores
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
El proceso comienza cuando es ingresada una orden de pedido simple en el sistema SICOM, automáticamente dicha orden queda disponible para ser consultada por el proveedor al que se le realizó la solicitud. Cada proveedor será el encargado de consultar sus solicitudes de órdenes de pedido, y lo podrá hacer a través de la URL: http://wss.sicom.gov.co/sicomdata/ProveedoresBasico(000000)/PedidoSimpleSolicitudes/. También se puede filtrar la información para leer paquetes menos pesados: http://wss.sicom.gov.co/sicomdata/ProveedoresBasico(000000)/PedidoSimpleSolicitudes/?$skip=5&$top=5&$inlinecount=allpages NOTA: El código ‘000000’ es el código SICOM del Proveedor. El tamaño recomendado de los ítems a consultar es 60.
La Confirmación de la recepción satisfactoria de la lista de solicitudes de órdenes de pedidos se realiza como se describe en el acápite “Confirmar recepción de órdenes de pedidos simples” (más abajo en este documento).
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
CONSULTAR ÓRDENES DE PEDIDOS SIMPLES
NOMBRE
DESCRIPCION
TIPO
*Id Identificador único de la transacción Alfanumérico (36)
*Proveedor_Codigo_SICOM
Código SICOM asignado al Agente Proveedor Alfanumérico (6)
Proveedor_NIT NIT del Agente Proveedor Alfanumérico(32)
*OP_Autorizacion_Codigo Código de autorización de la orden de pedido registrada Alfanumérico(15)
Comprador_Codigo_Externo
Código interno del cliente al cual se le debe realizar la venta. Este código es asignado por el Agente Proveedor. En caso de no asignar código, se envía el Codigo SICOM del agente Comprador.
Alfanumérico(16)
Despacho_Planta_Codigo Código SICOM de la planta de despacho (Agente Proveedor) Alfanumérico (6)
Recibo_Planta_Codigo Código SICOM de la planta de recibo (Agente Comprador)
Alfanumérico (6)
Transporte_Tipo_Codigo Código del Tipo de Transporte a utilizar. (Ver tabla de códigos). Alfanumérico (1)
Transporte_Placa Placa ó Matrícula del Transporte Alfanumérico(6)
Transporte_Placa_Remolque
Placa del Remolque. Aplica solo para tipo de transporte Tracto Camión. Alfanumérico(6)
Transporte_Conductor Nombre del Conductor Alfanumérico(100)
Transporte_Cedula_Conductor Número de Cédula del Conductor Numérico (16)
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
FechaEntrega Fecha sugerida de Entrega. Fecha, Formato
YYYY-MM-DDTHH:MM:SS
Fecha Fecha creación de la Orden de Pedido. Fecha, Formato
YYYY-MM-DDTHH:MM:SS
SobreCupo Establece si el pedido es sobre cupo. Alfa (1) , Valores S/N.
Observaciones Observación aplicada a la orden de pedido Alfanumérico(512)
Seguridad_Contrasena Contraseña establecida por el Agente. Opción de Datos Generales.
Alfanumérico(32)
*RowVersion Campo de verificación de SICOM Alfanumérico(16)
PRODUCTOS LISTA DE PRODUCTOS ASOCIADOS A
LA ORDEN DE PEDIDO. ALFANUMÉRICO
Formato: Codigo1-Volumen1-Cliente1|Codigo2-Volumen2-
Cliente2|CodigoN-VolumenN-ClienteN
La estructura de cada ítem es:
1. Codigo Código del Producto. Se envía según
tabla de códigos establecida por SICOM.
Alfanumérico (8)
2. Volumen Volumen Solicitado Numérico (12,2)
3. Cliente
Código de referencia del cliente. Se incluye únicamente cuando el Agente
Comprador es un Comercializador Industrial.
Alfanumérico (16)
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
1.3 Aceptar órdenes de pedidos simples creadas por los Agentes Compradores
Disponible para: Agentes Proveedores Después de recibida la orden simple el Agente proveedor podrá aceptar dicha orden especificando los productos aceptados y los volúmenes asociados a cada producto. Cada proveedor será el encargado de aceptar sus solicitudes de órdenes de pedido, y lo podrá hacer a través de la URL: http://wss.sicom.gov.co/sicomdata/PedidoSimpleAceptadosBasico/. Método POST Http.
ACEPTAR ORDENES DE PEDIDO SIMPLES
NOMBRE
DESCRIPCION
TIPO
*Id Identificador único de la transacción
Alfanumérico (36) (El mismo
identificador que se obtiene en la consulta de
solicitudes de pedidos simples)
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
*OP_Autorizacion_Codig
o
Código de Autorización SICOM de la Orden de
Pedido a Aceptar.
Alfanumérico(15)
Despacho_Planta_Codig
o
Código SICOM de la planta que realizará el despacho de la orden. Se envía
siempre y cuando se desee cambiar de planta, de lo contrario se omite.
Alfanumérico(6)
Transporte_Tipo_Codigo
Código del Tipo de Transporte a emplear. Se envía siempre y cuando se desee
cambiar el transporte asignado (Ver tabla de Códigos), de lo contrario se omite.
Numérico (1)
Transporte_Placa
Placa o Matrícula del Vehículo que realizará el transporte de los productos. Se envía siempre y cuando se desee cambiar el
transporte, de lo contrario se omite.
Alfanumérico(6)
Transporte_Placa_Remol
que
Placa del Remolque asociado. Se envía siempre y cuando se desee cambiar el
transporte y sea de tipo Tracto Camión (Ver tabla de Códigos),
de lo contrario se omite.
Alfanumérico(6)
*Seguridad_Contrasena Contraseña establecida por el Agente. Opción de Datos Generales.
Alfanumérico(32)
*RowVersion Campo de verificación de SICOM
Alfanumérico(16) (El mismo identificador que se obtiene en la
consulta de solicitudes de
pedidos simples)
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
Productos
Listado de los productos a aceptar. Se debe establecer el Código del Producto* y
su Volumen Aceptado*. El código debe enviarse según tabla de código establecida
por SICOM. Si no se envía este ítem se acepta de acuerdo a los productos y
volúmenes especificados en la solicitud.
(Descripción de
Solicitud de Orden de Pedido)
CONSIDERACIONES: a) La orden de Pedido (OP) a Aceptar debe estar en estado SOLICITADO b) Los Productos enviados deben pertenecer a la OP. c) Los Productos NO enviados, serán tomados como Rechazados. d) Si el Vendedor provee el transporte, el transporte debe pertenecer a dicho Agente y su capacidad debe ser mayor o igual a la suma de los volúmenes aceptados. e) La planta que se envía debe pertenecer al Agente Proveedor
1.4 Despachar órdenes de pedidos simples aceptadas a los Agentes Compradores
Disponible para: Agentes Proveedores Después de aceptada la orden simple el Agente proveedor podrá despachar parcial o total dicha orden especificando los productos y los volúmenes asociados a cada producto. Cada proveedor será el encargado de despachar sus solicitudes de órdenes de pedido, y lo podrá hacer a través de la URL: http://wss.sicom.gov.co/sicomdata/PedidoSimpleDespachadosBasico/. Método POST Http.
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
DESPACHAR ORDENES DE PEDIDO SIMPLES
NOMBRE
DESCRIPCION
TIPO
*Id Identificador único de la transacción
Alfanumérico (36) (El mismo
identificador que se obtiene en la consulta de
solicitudes de pedidos simples)
*OP_Autorizacion_Codigo
Código de Autorización SICOM de la Orden de Pedido a Despachar.
Alfanumérico(15)
Transporte_Tipo_Codigo
Código del Tipo de Transporte a emplear. Se envía siempre y cuando se desee
cambiar el transporte asignado (Ver tabla de Códigos), de lo contrario se omite.
Numérico (1)
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
Transporte_Placa
Placa o Matrícula del vehículo que realizará el transporte de los productos. Se envía siempre y cuando se desee cambiar
el transporte, o si no se especificó en la aceptación, de lo contrario se omite.
Alfanumérico(6)
Transporte_Placa_Remolque
Placa del remolque asociado. Se envía siempre y cuando se desee cambiar el
transporte y sea de tipo Tracto Camión (Ver tabla de Códigos), de lo contrario se omite.
Alfanumérico(6)
Transporte_Conductor Número de Cédula del conductor, se
omite el ítem si no se desea cambiar el conductor.
Alfanumérico(32)
*Despacho_Temperatura_Codigo
Código del Tipo de Temperatura con la cual se realiza el despacho. (Ver tabla de
códigos).
Alfa(1), valores N/E
*Despacho_Temperatura_Escala
Escala de la temperatura: Celsius, Farenheit.
Alfa(1), valores C/F
*Despacho_Temperatura
Temperatura con la cual se despachan los productos.
Numérico(3)
*Transporte_Guia_Numero
Número de la Guía Única de Transporte asociado al Vehículo.
Alfanumérico(20)
*Transporte_Guia_Vigencia Vigencia de la Guía Única de Transporte.
Alfanumérico(4) Formato HHMM
*Transporte_Guia_Fecha
Fecha de la Guía Única de Transporte. Fecha, Formato
YYYY-MM-DDTHH:MM:SS
Despacho_Factura Número de la Factura correspondiente al despacho dentro del sistema del Agente.
Alfanumérico(32)
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
*Seguridad_Usuario_Numero
Usuario SICOM de la planta de despacho Alfanumérico(32)
*Seguridad_Contrasena Contaseña establecida por el Agente. Opción de Datos Generales.
Alfanumérico(32)
*RowVersion Campo de verificación de SICOM
Alfanumérico(16) (El mismo identificador que se obtiene en la
consulta de solicitudes de
pedidos simples)
*Productos
Listado de los productos a despachar. Se debe establecer el Código del Producto*,
su Volumen Despachado* y su A.P.I.*
El código debe enviarse según tabla de código establecida por SICOM.
(Descripción de
Solicitud de Orden de Pedido)
CONSIDERACIONES: a) El usuario debe ser de tipo Planta, y debe ser la planta despachadora relacionada a la OP. b) La orden de Pedido (OP) a Despachar debe estar en estado ACEPTADO c) Los Productos enviados deben pertenecer a la OP y deben estar en estado ACEPTADO. d) Los Productos no enviados, serán tomados como NO Despachados.
1.5 Rechazar órdenes de pedidos simples creadas por los Agentes Compradores
Disponible para: Agentes Proveedores Después de solicitada o aceptada la orden simple, el Agente proveedor podrá rechazar dicha orden especificando los motivos.
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
Cada proveedor será el encargado de rechazar sus solicitudes de órdenes de pedido, y lo podrá hacer a través de la URL: http://wss.sicom.gov.co/sicomdata/PedidoSimpleRechazadosBasico/. Método POST Http.
|
RECHAZAR ORDENES DE PEDIDO SIMPLES
NOMBRE
DESCRIPCION
TIPO
*Id Identificador único de la transacción Alfanumérico (36) (El mismo identificador que se obtiene en la consulta de solicitudes de pedidos simples)
*OP_Autorizacion_Codigo
Código de Autorización SICOM de la Orden de Pedido a Rechazar.
Alfanumérico(15)
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
*Rechazo_Motivo_Codigo
Código del motivo por el cual se rechaza la orden de pedido. (Ver tabla de Códigos).
Numérico(2)
Rechazo_Motivo_Descripcion
Descripción del rechazo de la orden de pedido
Alfanumérico(128)
*Seguridad_Contrasena Contraseña del Agente asociado al usuario.
Alfanumérico(32)
*RowVersion Campo de verificación de SICOM Alfanumérico(16) (El mismo identificador que se obtiene en la consulta de solicitudes de pedidos simples)
1.6 Consultar órdenes de pedidos simples “Anulados” por los Agentes Compradores
Disponible para: Agentes Proveedores El proceso comienza cuando es anula una orden de pedido simple en el sistema SICOM, automáticamente dicha orden queda disponible para ser consultada por el proveedor al que se le realizó la solicitud. Cada proveedor será el encargado de consultar sus órdenes de pedido anuladas, y lo podrá hacer a través de la URL: http://wss.sicom.gov.co/sicomdata/ProveedoresBasico(000000)/PedidoSimpleAnulados/. También se puede filtrar la información para leer paquetes menos pesados: http://wss.sicom.gov.co/sicomdata/ProveedoresBasico(000000)/PedidoSimpleAnulados/?$skip=5&$top=5&$inlinecount=allpages NOTA: El código ‘000000’ es el código SICOM del Proveedor. El tamaño recomendado de los ítems a consultar es 60.
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
CONSULTAR ORDENES DE PEDIDOS ANULADAS DESDE SICOM
NOMBRE
DESCRIPCION
TIPO
*Id Identificador único de la transacción Alfanumérico (36)
*OP_Autorizacion_Codigo
Código de autorización de la orden de pedido anulada. Alfanumérico(15)
Comprador_Codigo_SICOM
Código SICOM asignado al Agente vendedor Numérico (6)
Anulacion_Fecha Fecha Anulación de la Orden. Fecha, Formato
YYYY-MM-DDTHH:MM:SS
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
Seguridad_Contrasena Password WS establecido por el agente. Opción de Datos Generales.
Alfanumérico(32)
*RowVersion Campo de verificación de SICOM Alfanumérico(16)
1.7 Consultar órdenes de pedidos simples “Rechazados” por los Agentes Proveedores
Disponible para: Agentes Compradores y Proveedores El proceso comienza cuando es “Rechazada” una orden de pedido simple en el sistema SICOM, automáticamente dicha orden queda disponible para ser consultada por el proveedor al que se le realizó la solicitud. Cada proveedor será el encargado de consultar sus órdenes de pedido anuladas, y lo podrá hacer a través de la URL: http://wss.sicom.gov.co/sicomdata/ProveedoresBasico(000000)/PedidoSimpleRechazados/. También se puede filtrar la información para leer paquetes menos pesados: http://wss.sicom.gov.co/sicomdata/ProveedoresBasico(000000)/PedidoSimpleRechazados/?$skip=5&$top=5&$inlinecount=allpages NOTA: El código ‘000000’ es el código SICOM del Proveedor. El tamaño recomendado de los ítems a consultar es 60.
CONSULTAR ORDENES DE PEDIDOS RECHAZADAS DESDE SICOM
NOMBRE
DESCRIPCION TIPO
*Id Identificador único de la transacción Alfanumérico (36)
*OP_Autorizacion_Codigo
Código de autorización de la orden de pedido anulada. Alfanumérico(15)
Rechazo_Fecha Fecha Rechazo de la Orden. Fecha, Formato
YYYY-MM-DDTHH:MM:SS
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
Rechazo_Motivo_Codigo Código del motivo por el cual se
rechaza la orden de pedido. (Ver tabla de Códigos).
Numérico(2)
Rechazo_Motivo_Descripcion
Descripción del rechazo de la orden de pedido Alfanumérico(128)
Seguridad_Contrasena Password WS establecido por el agente. Opción de Datos Generales. Alfanumérico(32)
*RowVersion Campo de verificación de SICOM Alfanumérico(16)
1.8 Confirmar recibo de pedidos en los diferentes procesos de consultas Disponible para: Agentes Proveedores Permite confirmar la recepción de los datos para todas las consultas de información de pedidos simples (Ej. Solicitudes, Rechazados, Anulados, Transferencias, etc.). Brinda la posibilidad de enviar la confirmación de todas las consultas realizadas previamente en un solo paquete. Cada Agente será el encargado de cerrar sus solicitudes de órdenes de pedido, y lo podrá hacer a través de la URL: http://wss.sicom.gov.co/sicomdata/PedidoSimpleRecibidosBasico(guid’Id’)/. Método PUT Http. Nota: El Id en la URL es el mismo Id de los parámetros de entrada.
CONFIRMAR RECIBO
NOMBRE
DESCRIPCION
TIPO
*Id Identificador único de la transacción Alfanumérico (36)
*OP_Autorizacion_Codigo
Código de autorización de la orden de pedido anulada. Alfanumérico(15)
Error_Codigo Código de error que genera el proveedor (si existe error) Alfanumérico(36)
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
Error_Mensaje Mensaje de error que genera el proveedor (si existe error) Alfanumérico(256)
*Estado_Codigo Estado de la orden de pedido (Ver tabla anexa) Numérico (2)
*Seguridad_Contrasena Contraseña establecido por el agente. Opción de Datos Generales. Alfanumérico(32)
*RowVersion Campo de verificación de SICOM
Alfanumérico(16) (El mismo identificador que se obtiene en la
consulta de solicitudes de pedidos simples)
1.9 Cambiar la Planta de despacho de las órdenes de pedidos simples aceptadas por los Agentes Proveedores
Disponible para: Agentes Proveedores Se aplica cuando se desee cambiar de planta por la cual se despachará la orden de pedido. Antes o después de aceptada la orden, puede ocurrir que cambie la planta programada para realizar el despacho, en este caso esta información se puede corregir utilizando esta acción. Cada proveedor será el encargado de realizar el cambio de planta de despacho, y lo podrá hacer a través de la URL: http://wss.sicom.gov.co/sicomdata/PedidoSimpleDespachosBasico/. Método POST Http
CAMBIAR LA PLANTA DE DESPACHO DE LAS ORDENES DE PEDIDOS
NOMBRE
DESCRIPCION
TIPO
*Id Identificador único de la transacción
Alfanumérico (36) (El mismo
identificador que se obtiene en la consulta de
solicitudes de pedidos simples)
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
*OP_Autorizacion_Codig
o
Código de Autorización SICOM de la Orden de
Pedido a la cual se le realiza el cambio de planta.
Alfanumérico(15)
*Despacho_Planta_Codi
go
Código SICOM de la planta que despachará la
Orden de pedido.
Alfanumérico(6)
*Seguridad_Contrasena Password WS del agente asociado al usuario. Alfanumérico(32)
*RowVersion Campo de verificación de SICOM
Alfanumérico(16) (El mismo identificador que se obtiene en la
consulta de solicitudes de
pedidos simples)
NOTA: Los datos marcados con (*) son obligatorios, los demás son opcionales. Los datos opcionales que no es necesario enviar, se omiten. Para los volumenes de productos, enviar cero (0). 4.2 CONTINGENCIA
¿Qué pasa cuando los servicios Web dejan de funcionar? Las órdenes de pedido simples (OP) creadas a través del sistema SICOM se mantienen disponibles para ser consultadas por los Agentes Proveedores.
Una vez se restauran los servicios, se podrán consultar todas las órdenes de pedidos
simples que se han creado, anulado o rechazado por los Agentes Compradores, y simultáneamente realizar las demás acciones sobre el sistema nuevamente.
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
¿Qué pasa cuando el sistema SICOM deja de funcionar?
En este caso se procede a utilizar el formato de contingencia (luego de cumplirse el plazo acordado) y procesar las OP manualmente. Estas OP no son tratadas por los servicios Web de SICOM, el Agente no recibirá datos referentes a una orden de pedido que él haya tratado en el formato de contingencia.
5. ANEXOS
Lista de Productos
CODIGO
COMBUSTIBLES BÁSICOS
101
GASOLINA CORRIENTE
102
GASOLINA EXTRA
103
DIESEL CORRIENTE
104
DIESEL EXTRA
101
GASOLINA CORRIENTE
ES
BIOCOMBUSTIBLES
300
BIODIESEL B100
600
ETANOL - ALCOHOL CARBURANTE E100
COMBUSTIBLES OXIGENADOS
131
GASOLINA CORRIENTE OXIGENADA
(nombre en general)
141
GASOLINA EXTRA OXIGENADA (nombre
en general)
COMBUSTIBLES DE AVIACIÓN
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
151
AVIGAS
152
JP- 1A
153
COMBUSTIBLES MARINOS
154
DIESEL MARINO
155
IFO 380
156
IFO 180
COMBUSTIBLES PARA QUEMADORES INDUSTRIALES
161
FUEL OIL
162
COMBUSTOLEO
163
MEZCLAS DE CRUDOS PESADOS
164
CRUDO
165
MEZCLAS DE BIODIESEL Y DIESEL FÓSIL
166
MEZCLAS <= B5
167
MEZCLAS > B5
MATERIAS PRIMAS
171
ACEITE LIVIANO DE CICLO
172
CRUDOS PESADOS
173
OTROS DILUYENTES
174
PETROLEO CRUDO
182
KEROSENE- QUEROSENE
183
NAFTA
OTROS
181
BENCINA
182
KEROSENE- QUEROSENE
183
NAFTA
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
COMBUSTIBLES OXIGENADOS DIESEL+ BIODIESEL
CODIGO
NOMBRE
BIODIESEL
DIESEL
200 B
0
0%
201
B
1
1%
202
B
2
2%
203
B
3
3%
204
B
4
4%
205
B
5
5%
206
B
6
6%
207
B
7
7%
208
B
8
8%
209
B
9
9%
210
B
10
10%
211
B
11
11%
212
B
12
12%
213
B
13
13%
214
B
14
14%
215
B
15
15%
216
B
16
16%
217
B
17
17%
218
B
18
18%
219
B
19
19%
220
B
20
20%
221
B
21
21%
222
B
22
22%
223
B
23
23%
224
B
24
24%
225
B
25
25%
226
B
26
26%
227
B
27
27%
228
B
28
28%
229
B
29
29%
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
230
B
30
30%
231
B
31
31%
232
B
32
32%
233
B
33
33%
234
B
34
34%
235
B
35
35%
236
B
36
36%
237
B
37
37%
238
B
38
38%
239
B
39
39%
240
B
40
40%
241
B
41
41%
242
B
42
42%
243
B
43
43%
244
B
44
44%
245
B
45
45%
246
B
46
46%
247
B
47
47%
248
B
48
48%
249
B
49
49%
250
B
50
50%
251
B
51
51%
252
B
52
52%
253
B
53
53%
254
B
54
54%
255
B
55
55%
256
B
56
56%
257
B
57
57%
258
B
58
58%
259
B
59
59%
260
B
60
60%
261
B
61
61%
262
B
62
62%
263
B
63
63%
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
264 B 64 64%
265 B
65
65%
266
B
66
66%
267
B
67
67%
268
B
68
68%
269
B
69
69%
270
B
70
70%
271
B
71
71%
272
B
72
72%
273
B
73
73%
274
B
74
74%
275
B
75
75%
276
B
76
76%
277
B
77
77%
278
B
78
78%
279
B
79
79%
280
B
80
80%
281
B
81
81%
282
B
82
82%
283
B
83
83%
284
B
84
84%
285
B
85
85%
286
B
86
86%
287
B
87
87%
288
B
88
88%
289
B
89
89%
290
B
90
90%
291
B
91
91%
292
B
92
92%
293
B
93
93%
294
B
94
94%
295
B
95
95%
296
B
96
96%
297
B
97
97%
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
298 B 98 98%
299 B
99
99%
300
B
100
100%
CODIGO NOMBRE ETANOL GASOLINA
500
E 0
0%
100%
501 COMBUSTIBLES
1
1%
99%
502
E
2
2%
98%
503
E
3
3%
97%
504
E
4
4%
96%
505
E
5
5%
95%
506
E
6
6%
94%
507
E
7
7%
93%
508
E
8
8%
92%
509
E
9
9%
91%
510
E
10
10%
90%
511
E
11
11%
89%
512
E
12
12%
88%
513
E
13
13%
87%
514
E
14
14%
86%
515
E
15
15%
85%
516
E
16
16%
84%
517
E
17
17%
83%
518
E
18
18%
82%
519
E
19
19%
81%
520
E
20
20%
80%
521
E
21
21%
79%
522
E
22
22%
78%
523
E
23
23%
77%
524 E
24
24%
76%
525
E
25
25%
75%
526
E
26
26%
74%
527
E
27
27%
73%
528
E
28
28%
72%
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
529
E
29
29%
71%
530
E
30
30%
70%
531
E
31
31%
69%
532
E
32
32%
68%
533
E
33
33%
67%
534
E
34
34%
66%
535
E
35
35%
65%
536
E
36
36%
64%
537 E
37
37%
63%
538
E
38
38%
62%
539 E
39
39%
61%
540
E
40
40%
60%
541 E
41
41%
59%
542
E
42
42%
58%
543 E
43
43%
57%
544
E
44
44%
56%
545 E
45
45%
55%
546
E
46
46%
54%
547 E
47
47%
53%
548
E
48
48%
52%
549 E
49
49%
51%
550
E
50
50%
50%
551 E
51
51%
49%
552
E
52
52%
48%
553 E
53
53%
47%
554
E
54
54%
46%
555 E
55
55%
45%
556
E
56
56%
44%
557 E
57
57%
43%
558
E
58
58%
42%
559 E
59
59%
41%
560
E
60
60%
40%
561
E
61
61%
39%
562
E
62
62%
38%
563
E
63
63%
37%
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
564
E
64
64%
36%
565
E
65
65%
35%
566
E
66
66%
34%
567
E
67
67%
33%
568
E
68
68%
32%
569
E
69
69%
31%
570
E
70
70%
30%
571
E
71
71%
29%
572 E
72
72%
28%
573
E
73
73%
27%
574 E
74
74%
26%
575
E
75
75%
25%
576 E
76
76%
24%
577
E
77
77%
23%
578 E
78
78%
22%
579
E
79
79%
21%
580 E
80
80%
20%
581
E
81
81%
19%
582 E
82
82%
18%
583
E
83
83%
17%
584 E
84
84%
16%
585
E
85
85%
15%
586 E
86
86%
14%
587
E
87
87%
13%
588 E
88
88%
12%
589
E
89
89%
11%
590 E
90
90%
10%
591
E
91
91%
9%
592 E
92
92%
8%
593
E
93
93%
7%
594 E
94
94%
6%
595
E
95
95%
5%
596
E
96
96%
4%
597
E
97
97%
3%
598
E
98
98%
2%
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
599
E
99
99%
1%
600
E
100
100%
0%
Tipos de órdenes de pedido
CODIGO DESCRIPCION
S
Orden simple
M
Orden múltiple
P
Orden programada
A
Orden anticipada
Estados de órdenes de pedido
CODIGO DESCRIPCION
1
SOLICITADA
2
ACEPTADA
3
DESPACHADA
4
ENTREGADA
5
CERRADA_PARCIAL
6
CERRADA
7
ANULADA
8
RECHAZADA
9
RECIBIDA
Tipos de transporte
CODIGO DESCRIPCION
0
NINGUN TRANSPORTE
1
CARROTANQUE
2
BARCAZA
5
NAVE
8
TRACTO CAMION
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
Tipos de temperatura
CODIGO DESCRIPCION
N
NORMAL
E
ESTANDAR
Motivos de rechazo
CODIGO DESCRIPCION
3
CARTERA
4
PRODUCTO FUERA DE
PARÁMETROS DE MARCACIÓN
5
PRODUCTO FUERA
DE ESPECIFICACIONES
DE CALIDAD
6
LOGÍSTICA OPERATIVA
7
MANTENIMIENTO
8
SISTEMA
9
LOGÍSTICA DEL TRANSPORTE
10
RESTRICCIÓN VEHICULAR
11
ANULACION DE ORDEN
12
PRODUCTO
CONTAMINADO
13
PRODUCTO EQUIVOCADO
14
PRODUCTO NO CUMPLE
NORMAS DE CALIDAD
15
NO AUTORIZADO POR
ECOPETROL
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
16 NO SE ENCUENTRA AL DIA CON LOS PAGOS
17
SOLICITUD ERRADA
18
ERROR EN EL DESPACHO
19
NO CUMPLE CONDICION
REGLAMENTACION ESPECIAL
32
EN LITIGIO
33
EN PROCESO JUDICIAL
34
EN PLEITO
Listado de validaciones y reglas de negocio
Aceptar órdenes de pedidos simples
DESCRIPCIÓN REGLAS
El login del usuario debe encontrarse registrado en el SICOM y estar activo (es el código del agente mayorista más "001") El login del usuario no puede tener mas de un registro en el SICOM El código SICOM del mayorista debe encontrarse registrado como Agente y estar activo El código SICOM del mayorista no puede tener más de un registro como Agente El password del webservice se debe encontrar registrado en el SICOM para el Agente Vendedor El código de Autorización enviado debe encontrarse registrado en el SICOM El código de Autorización no puede tener más de un registro en el SICOM El código de Autorización debe pertenecer a una OP del tipo (SIMPLE). La orden de Pedido debe pertenecer al Agente Vendedor y la Orden de Pedido debe estar en estado SOLICITADA El Agente comprador debe estar registrado como Agente El Agente comprador no puede tener más de un registro como Agente en el SICOM El agente comprador no puede tener registrada ninguna SANCION activa al momento de procesar la orden de pedido
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
La planta del Vendedor enviada no corresponde a la Orden de pedido La planta del Vendedor enviada no pertenece al Agente Vendedor La planta del Vendedor enviada tiene más de un registro para el Agente Vendedor El tipo de transporte enviado debe ser válido (debe estar registrado en el SICOM) El TRACTO CAMION debe existir, estar activo y estar Asociado al Agente Vendedor El TRACTO CAMION no puede tener más de un registro para el Agente Vendedor El CARRO TANQUE debe existir, estar activo y estar Asociado al Agente Vendedor El CARRO TANQUE no puede tener más de un registro para el Agente Vendedor El transporte enviado debe existir, estar activo y estar Asociado al Agente Vendedor El transporte enviado no puede tener más de un registro para el Agente Vendedor El total del Volumen Aceptado no puede ser Mayor a la capacidad de Almacenamiento para el transporte Si el volumen aceptado es mayor al solicitado se valida que haya cupo para reservar El Producto enviado debe estar registrado en SICOM El Producto enviado no puede estar registrado en SICOM más de una vez El Producto enviado debe estar registrado en SICOM para la Orden de Pedido El Producto enviado no puede tener más de un registro en SICOM para la Orden de Pedido El valor del Producto y del Volumen deben ser numéricos Debe existir cupo disponible de la GASOLINA y sus MEZCLAS para la reserva en la ACEPTACION Debe existir cupo disponible del ACPM y sus MEZCLAS para la reserva en la ACEPTACION El transporte debe tener conductor asociado El transporte debe tener nombre del conductor asociado Si la orden es a precio nacional, La suma del Volumen Aceptado no puede exceder el Cupo Nacional del Mes Disponible
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
Despachar órdenes de pedidos simples
DESCRIPCION REGLAS El login del usuario de la planta debe encontrarse registrado en el SICOM y estar activo El login del usuario de la planta no puede tener más de un registro en el SICOM El código SICOM del mayorista debe encontrarse registrado como Agente y estar activo El código SICOM del mayorista no puede tener más de un registro como Agente El password del webservice se debe encontrar registrado en el SICOM para el Agente Vendedor El código de Autorización enviado debe encontrarse registrado en el SICOM El código de Autorización no puede tener más de un registro en el SICOM El código de Autorización debe pertenecer a una OP del tipo (SIMPLE). La orden de Pedido debe pertenecer al Agente Vendedor y la Orden de Pedido debe estar en estado ACEPTADA
El Agente comprador debe estar registrado como Agente El Agente comprador no puede tener más de un registro como Agente en el SICOM El agente comprador no puede tener registrada ninguna SANCION activa al momento de procesar la orden de pedido
La planta del Vendedor enviada no corresponde a la Orden de pedido La planta del Vendedor enviada no pertenece al Agente Vendedor La planta del Vendedor enviada tiene más de un registro para el Agente Vendedor Si para la OP aplica cumplido y es de zona de frontera, ésta debe contar con el cumplido del puesto de control para el despacho
Debe enviar la Guía de Transporte Debe enviar la Vigencia de la Guía de Transporte Debe enviar la fecha de inicio de Vigencia de la Guía de Transporte Debe enviar el Tipo de la Temperatura valido Normal o Estándar Debe enviar la escala de Temperatura válido Centígrados o Fahrenheit Debe de ingresar como valor de temperatura mayor a cero Cuando no se registró transporte en la aceptación se debe enviar la placa de transporte El tipo de transporte enviado debe ser válido (debe estar registrado en el SICOM) El TRACTO CAMION debe existir, estar activo y estar Asociado al Agente Vendedor El TRACTO CAMION no puede tener más de un registro para el Agente Vendedor El CARRO TANQUE debe existir, estar activo y estar Asociado al Agente Vendedor El CARRO TANQUE no puede tener más de un registro para el Agente Vendedor El transporte enviado debe existir, estar activo y estar Asociado al Agente Vendedor El transporte enviado no puede tener más de un registro para el Agente Vendedor
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
El total del Volumen Despachado no puede ser Mayor a la capacidad de Almacenamiento para el transporte Si el volumen aceptado es mayor al solicitado se valida que haya cupo para reservar El Producto enviado debe estar registrado en SICOM El Producto enviado no puede estar registrado en SICOM más de una vez El Producto enviado debe estar registrado en SICOM para la Orden de Pedido El Producto enviado no puede tener más de un registro en SICOM para la Orden de Pedido El valor del Producto y del Volumen deben ser numéricos Los productos a despachar deben estar en estado aceptado Debe existir cupo disponible de la GASOLINA y sus MEZCLAS para consumir en el DESPACHO Debe existir cupo disponible del ACPM y sus MEZCLAS para consumir en el DESPACHO El transporte debe tener conductor asociado El transporte debe tener nombre del conductor asociado El agente vendedor debe tener asociado al conductor si el transporte es suministrado por el mayorista Si la orden es a precio nacional, La suma del Volumen Despachado no puede exceder el Cupo Nacional del Mes Disponible
El punto de entrega no puede superar los 20000 galones despachados en el mes El número de órdenes en estado despachado para el agente comprador no puede superar el máximo de ordenes activas parametrizadas (el valor está en 3)
No puede haber más de una (valor parametrizable) orden de pedido en estado despachada para el mismo agente comprador y transporte
MANUAL WEB SERVICES 2.2
ORDENES DE PEDIDO SIMPLES
CÓDIGO
FECHA VERSIÓN
Rechazar órdenes de pedidos simples
DESCRIPCION REGLAS
El login del usuario debe encontrarse registrado en el SICOM y estar activo (es el código del agente mayorista más "001")
El login del usuario no puede tener más de un registro en el SICOM El código SICOM del mayorista debe encontrarse registrado como Agente y estar activo El código SICOM del mayorista no puede tener más de un registro como Agente El password del webservice se debe encontrar registrado en el SICOM para el Agente Vendedor El código de Autorización enviado debe encontrarse registrado en el SICOM El código de Autorización no puede tener más de un registro en el SICOM El código del motivo de rechazo debe estar registrado en el SICOM El código del motivo de rechazo no puede estar registrado en el SICOM más de una vez La orden de Pedido debe pertenecer al Agente Vendedor y al agente Comprador Si el usuario es una planta la OP debe estar en estado Aceptada Si el usuario es un agente vendedor la OP debe estar en estado Solicitada