API SGA

Esta parte de la API de CAMPILLOPALMERA se va a utilizar para gestionar la información relativa al Sistema Gestor de Almacenes (en adelante SGA).

Funciones SGA

Artículos
sgaAddArticulos(Collection Articulo, Boolean saveRelated, Integer onError) return Integer
sgaGetArticulos(String codigo, Array RelatedEntities) return Collection Articulo
sgaGetArticulosInventario(String codigo) return Collection Articulo

Destinatarios
sgaAddDestinatarios(Collection Destinatario, Boolean saveRelated, Integer onError) return Integer
sgaGetDestinatarios(String codigo, Array RelatedEntities) return Collection Destinatario

Destinos
sgaAddDestinos(Collection Destino, Boolean saveRelated, Integer onError) return Integer
sgaGetDestinos(String codigo, Array RelatedEntities) return Collection Destino

Familias
sgaAddFamilias(Collection Familia, Integer onError) return Integer
sgaGetFamilias(String codigo, Array RelatedEntities) return Collection Familia

OrdenesExpedicion
sgaAddOrdenesExpedicion(Collection OrdenExpedicion, Boolean saveRelated, Integer onError) return Integer
sgaDeleteOrdenExpedicion(String referencia) return Integer
sgaGetOrdenesExpedicion( String desde, String hasta, String expedicion, String referencia, String proveedor_codigo, String transportista_codigo, Array RelatedEntities) return Collection OrdenExpedicion

OrdenesExpedicionDetalles
sgaAddOrdenesExpedicionDetalles(Collection OrdenExpedicionDetalles, Integer onError) return Integer
sgaGetOrdenesExpedicionDetalles( String desde, String hasta, String expedicion, String expedicion_referencia, String articulo_codigo, Array RelatedEntities) return Collection OrdenExpedicionDetalles

OrdenesRecepcion
sgaAddOrdenesRecepcion(Collection OrdenRecepcion, Boolean saveRelated, Integer onError) return Integer
sgaDeleteOrdenRecepcion(String referencia) return Integer
sgaGetOrdenesRecepcion( String desde, String hasta, String recepcion, String referencia, String proveedor_codigo, String transportista_codigo, Array RelatedEntities) return Collection OrdenRecepcion
sgaGetOrdenesTraspaso( String desde, String hasta, String recepcion, String referencia, String proveedor_codigo, String transportista_codigo, Array RelatedEntities) return Collection OrdenRecepcion

OrdenesRecepcionDetalles
sgaAddOrdenesRecepcionDetalles(Collection OrdenRecepcionDetalles, Boolean saveRelated, Integer onError) return Integer
sgaGetOrdenesRecepcionDetalles( String desde, String hasta, String recepcion, String recepcion_referencia, String articulo_codigo, Array RelatedEntities) return Collection OrdenRecepcionDetalles

Proveedores
sgaAddProveedores(Collection Proveedor, Boolean saveRelated, Integer onError) return Integer
sgaGetProveedores(String codigo, Array RelatedEntities) return Collection Proveedor

Traducciones
sgaAddTraducciones(Collection Traduccion, Integer onError) return Integer
sgaGetTraducciones(String articulo_codigo, String pais) return Collection Traduccion

Transportistas
sgaAddTransportistas(Collection Transportista, Integer onError) return Integer
sgaGetTransportistas(String codigo, Array RelatedEntities) return Collection Transportista

Consultas de Maestros
sgaGetCategorias(String codigo) return Collection Categoria
sgaGetClasesPales(String codigo, Array RelatedEntities) return Collection ClasePale
sgaGetCriteriosPesaje(String criterio_pesaje) return Collection CriterioPesaje
sgaGetCriteriosRotacion(String criterio_rotacion) return Collection CriterioRotacion
sgaGetEstadosPales(String estado_pale) return Collection EstadoPale
sgaGetTiposEnvases(String codigo) return Collection TipoEnvase
sgaGetTiposPales(String codigo, Array RelatedEntities) return Collection TipoPale
sgaGetUnidades(String unidad) return Collection Unidad

Entidades SGA

Articulo
codigo	varchar(20)	Obligatorio	Código único de artículo
codigo_externo	varchar(20)	Opcional
gtin13	bigint	Opcional	Mostrar GTIN 13
descripcion	varchar(255)	Obligatorio
proveedor_codigo	varchar(20)	Opcional	Proveedor habitual del artículo.
familia_codigo	varchar(10)	Opcional	Obligatorio Si se establece subfamilia_codigo
subfamilia_codigo	varchar(10)	Opcional
categoria_codigo	varchar(10)	Opcional	Valor por defecto (SEC). Ver Maestro sgaGetCategorias()
unidad	varchar(5)	Opcional	Valor por defecto (PA). Ver Maestro sgaGetUnidades()
tipo_envase_codigo	varchar(20)	Opcional	Valor por defecto (TARA_CERO). Ver Maestro sgaGetTiposEnvases()
tipo_pale_codigo	varchar(20)	Opcional	Valor por defecto (EURO_TARA_CERO). Ver Maestro sgaGetTiposPales()
criterio_rotacion	varchar(20)	Opcional	Valor por defecto (FIFO). Ver Maestro sgaGetCriteriosRotacion()
criterio_pesaje	varchar(20)	Opcional	Valor por defecto (PESO_ESTANDAR). Ver Maestro sgaGetCriteriosPesaje()
requiere_numero_serie	(boolean) int	Opcional	Valor por defecto (0). 0 Artículos sin Nº de Serie. 1 Artículos con Nº de Serie.
requiere_volumen_recepcion	(boolean) int	Opcional	Valor por defecto (0). 0 Artículo No requiere Volumen. 1 Artículo requiere Volumen.
monoformato	(boolean) int	Opcional	Valor por defecto (0). 1 Formato de presentación Único 0 Se especifica el formato en OrdenRecepcionDetalles.
peso	float	Opcional	Peso de la unidad en KG. Obligatorio Si monoformato es true
base	int	Opcional	Nº de unidades (de presentación) en la base del palé. Obligatorio Si monoformato es true
altura	int	Opcional	Nº de bases en la altura del palé. Obligatorio Si monoformato es true
Categoria	Categoria	Sólo Lectura
Familia	Familia	Sólo Lectura
Subfamilia	Subfamilia	Sólo Lectura
Proveedor	Proveedor	Opcional	saveRelated
Unidad	Unidad	Sólo Lectura
Traducciones	Collection Traduccion	Opcional	saveRelated

Destinatario
codigo	varchar(20)	Obligatorio	Código único de destinatario.
codigo_externo	varchar(20)	Opcional	Reservado para su codigo de referencia.
razon_social	varchar(60)	Obligatorio
cif	varchar(20)	Obligatorio
direccion	varchar(255)	Obligatorio
codigo_postal	varchar(10)	Obligatorio
poblacion	varchar(60)	Obligatorio
municipio	varchar(60)	Opcional
provincia	varchar(60)	Obligatorio
pais	varchar(2)	Opcional	Valor por defecto (ES). Mostrar ISO 3166-1
telefono	varchar(20)	Opcional	Telefono de contacto
contacto	varchar(60)	Opcional	Persona de contacto
e_mail	varchar(60)	Opcional	Email de contacto / notificaciones
notas	text	Opcional
Destinos	Collection Destino	Opcional	saveRelated

Destino
codigo	varchar(20)	Obligatorio	Código de destino único por destinatario.
codigo_externo	varchar(20)	Opcional	Reservado para su codigo de referencia.
destinatario_codigo	varchar(20)	Obligatorio	Opcional Si se relaciona con Destinatario
denominacion	varchar(60)	Obligatorio
direccion	varchar(255)	Obligatorio
codigo_postal	varchar(10)	Obligatorio
poblacion	varchar(60)	Obligatorio
municipio	varchar(60)	Opcional
provincia	varchar(60)	Obligatorio
pais	varchar(2)	Opcional	Valor por defecto (ES). Mostrar ISO 3166-1
telefono	varchar(20)	Opcional	Telefono de contacto
contacto	varchar(60)	Opcional	Persona de contacto
e_mail	varchar(60)	Opcional	Email de contacto / notificaciones
notas	text	Opcional
Destinatario	Destinatario	Opcional	saveRelated

Familia
codigo	varchar(10)	Obligatorio	Código único de familia.
codigo_externo	varchar(10)	Opcional
descripcion	varchar(60)	Obligatorio
Articulos	Collection Articulo	Sólo Lectura
Subfamilias	Collection Subfamilia	Opcional	saveRelated

NumeroSerie
numero_serie	varchar(20)	Obligatorio	Nº de serie.

OrdenExpedicion
tipo	int	Obligatorio	1-> Se van a indicar artículos y unidades 2-> Se van a detallar los códigos de cada unidad.
expedicion	varchar(20)	Sólo Lectura	Nº Expedición SGA
referencia	varchar(20)	Obligatorio	Referencia propia (Su identificador para la expedición).
fecha	datetime	Obligatorio	Fecha prevista de expedición. Formato: dd-mm-yyyy H:i (24H)
fecha_fin_expedicion	datetime	Sólo Lectura	Fecha de finalizacion real de expedición. Formato: dd-mm-yyyy H:i (24H)
destinatario_codigo	varchar(20)	Obligatorio	Opcional Si se relaciona con Destino
destino_codigo	varchar(20)	Obligatorio	Opcional Si se relaciona con Destino
transportista_codigo	varchar(20)	Obligatorio	Opcional Si se incluye Transportista
traduccion_pais	varchar(2)	Opcional	País de la Traduccion. Mostrar ISO 3166-1
notas_almacen	text	Opcional	Notas para almacén de la orden de expedición
notas_entrega	text	Opcional	Notas para el transportista de la orden de expedición
notas_import_export	text	Opcional
notas_carga	text	Opcional
divisa	varchar(3)	Opcional	Mostrar ISO 4217
incoterm	varchar(3)	Opcional	Mostrar Incoterm
tipo_servicio	varchar(20)	Opcional	NORMAL -> Servicio Normal (Predeterminado) URGENTE -> Servicio Urgente ESPECIAL -> Servicio Especial
fecha_entrega	datetime	Opcional	Formato: dd-mm-yyyy H:i (24H)
terminos_entrega	varchar(60)	Opcional
valoracion_transporte	decimal	Opcional
volumen_lineal	decimal	Opcional
observaciones	text	Opcional
observaciones_internas	text	Opcional
Destinatario	Destinatario	Sólo Lectura
Destino	Destino	Opcional	saveRelated
Transportista	Transportista	Opcional	saveRelated
OrdenExpedicionDetalles	Collection OrdenExpedicionDetalles	Obligatorio	saveRelated

OrdenExpedicionDetalles
expedicion	varchar(20)	Sólo Lectura	Nº Expedición SGA
expedicion_referencia	varchar(20)	Obligatorio	Opcional Si proviene de OrdenExpedicion
articulo_codigo	varchar(20)	Obligatorio
unidades	int	Obligatorio	Será 1 si el tipo de orden es 2
lote	varchar(60)	Opcional	Código de lote del producto
sscc	bigint	Opcional	Obligatorio Si OrdenExpedicion.tipo es 2
notas	text	Opcional
notas_extra	text	Opcional
precio_unitario	decimal	Opcional
impuesto_aplicable	decimal	Opcional
codigo_aduanas	varchar(50)	Opcional
codigo_cliente	varchar(50)	Opcional
referencia_extra	varchar(50)	Opcional
Articulo	Articulo	Sólo Lectura
OrdenExpedicion	OrdenExpedicion	Sólo Lectura
Pales	Collection Pale	Sólo Lectura

OrdenRecepcion
tipo	int	Obligatorio	1-> Se detallan artículos y unidades 2-> Se detallan los SSCC/NºSERIE de cada palé.
recepcion	varchar(20)	Sólo Lectura	Nº Recepción SGA
referencia	varchar(20)	Obligatorio	Referencia propia (Su identificador para la recepción).
fecha	datetime	Obligatorio	Fecha prevista de recepción. Formato: dd-mm-yyyy H:i (24H)
proveedor_codigo	varchar(20)	Obligatorio	Opcional Si se incluye Proveedor
transportista_codigo	varchar(20)	Obligatorio	Opcional Si se incluye Transportista
notas_almacen	text	Opcional	Notas para el almacén
notas_entrega	text	Opcional
notas_import_export	text	Opcional
notas_descarga	text	Opcional	Notas para la descarga
Proveedor	Proveedor	Opcional	saveRelated
Transportista	Transportista	Opcional	saveRelated
OrdenRecepcionDetalles	Collection OrdenRecepcionDetalles	Obligatorio	saveRelated
OrdenesRelacionadas	Collection OrdenRecepcion	Sólo Lectura	Ordenes de recepción generadas con los restos del pedido. Devolverá las mismas entidades relacionadas que la llamada principal.

OrdenRecepcionDetalles
recepcion	varchar(20)	Sólo Lectura	Nº Recepción SGA
recepcion_referencia	varchar(20)	Obligatorio	Opcional Si proviene de OrdenRecepcion
articulo_codigo	varchar(20)	Obligatorio
unidades	int	Obligatorio	Si se detallan NumeroSerie deberá coincidir con estos.
lote	varchar(20)	Opcional	Código de lote del producto
sscc	bigint	Opcional	Especificación SSCC-18
peso	float	Obligatorio	Peso de la unidad en KG. Opcional Si artículo es monoformato
base	int	Obligatorio	Nº de unidades (de presentación) en la base del palé. Opcional Si artículo es monoformato
altura	int	Obligatorio	Nº de bases en la altura del palé. Opcional Si artículo es monoformato
tipo_envase_codigo	varchar(20)	Opcional	Valor por defecto (TARA_CERO). Ver Maestro sgaGetTiposEnvases()
tipo_pale_codigo	varchar(20)	Opcional	Valor por defecto (EURO_TARA_CERO). Ver Maestro sgaGetTiposPales()
notas	text	Opcional
Articulo	Articulo	Sólo Lectura
OrdenRecepcion	OrdenRecepcion	Sólo Lectura
NumerosSerie	Collection NumeroSerie	Opcional	saveRelated
Pales	Collection Pale	Sólo Lectura

Pale
sscc	bigint	Sólo Lectura
fecha_recepcion	datetime	Sólo Lectura	Formato: dd-mm-yyyy H:i (24H)
estado_pale	EstadoPale	Sólo Lectura	Ver Maestro sgaGetEstadosPales()
num_envases	integer	Sólo Lectura
peso_bruto	float	Sólo Lectura
peso_neto	float	Sólo Lectura
tara	float	Sólo Lectura
lote	varchar(20)	Sólo Lectura
almacen_codigo	varchar(20)	Sólo Lectura
zona_codigo	varchar(20)	Sólo Lectura
bloque_codigo	varchar(20)	Sólo Lectura
numero_fila	integer	Sólo Lectura
numero_altura	integer	Sólo Lectura
Items	Collection NumeroSerie	Sólo Lectura

Proveedor
codigo	varchar(20)	Obligatorio	Código único de proveedor.
codigo_externo	varchar(20)	Opcional	Reservado para su codigo de referencia.
razon_social	varchar(60)	Obligatorio
cif	varchar(20)	Obligatorio
direccion	varchar(255)	Obligatorio
codigo_postal	varchar(10)	Obligatorio
poblacion	varchar(60)	Obligatorio
municipio	varchar(60)	Opcional
provincia	varchar(60)	Obligatorio
pais	varchar(2)	Opcional	Valor por defecto (ES). Mostrar ISO 3166-1
telefono	varchar(20)	Opcional	Telefono de contacto
contacto	varchar(60)	Opcional	Persona de contacto
e_mail	varchar(60)	Opcional	Email de contacto / notificaciones
notas	text	Opcional
Articulos	Collection Articulo	Opcional	saveRelated

Subfamilia
codigo	varchar(10)	Obligatorio	Código único de subfamilia.
familia_codigo	varchar(10)	Obligatorio	Opcional Si se relaciona con Familia.
codigo_externo	varchar(10)	Opcional
descripcion	varchar(60)	Obligatorio
Articulos	Collection Articulo	Sólo Lectura

Traduccion
articulo_codigo	varchar(20)	Obligatorio	Opcional Si se relaciona con Articulo
pais	varchar(2)	Obligatorio	Mostrar ISO 3166-1
descripcion	varchar(255)	Obligatorio

Transportista
codigo	varchar(20)	Obligatorio	Código único del transportista.
razon_social	varchar(60)	Obligatorio
cif	varchar(20)	Obligatorio
direccion	varchar(255)	Obligatorio
codigo_postal	varchar(10)	Obligatorio
poblacion	varchar(60)	Obligatorio
municipio	varchar(60)	Opcional
provincia	varchar(60)	Obligatorio
pais	varchar(2)	Opcional	Valor por defecto (ES). Mostrar ISO 3166-1
telefono	varchar(20)	Opcional	Telefono de contacto
contacto	varchar(60)	Opcional	Persona de contacto
e_mail	varchar(60)	Opcional	Email de contacto / notificaciones
notas	text	Opcional
OrdenesRecepcion	Collection OrdenesRecepcion	Sólo Lectura

Maestros SGA

Los Maestros son Entidades NO administrables cuya única función disponible será la consulta. Algunas Entidades pueden necesitar de Entidades Maestras para su inserción.

Categoria
id_categoria	integer
codigo	varchar(10)
descripcion	varchar(60)
criterio_rotacion	varchar(20)	Vease criterios de rotación

ClasePale
codigo	varchar(10)
descripcion	varchar(60)
TiposPales	Collection TipoPale

CriterioPesaje
criterio_pesaje	varchar(20)	Criterio de Pesaje

CriterioRotacion
criterio_rotacion	varchar(20)	Criterio de rotación

EstadoPale
estado_pale	varchar(20)

TipoEnvase
codigo	varchar(10)
descripcion	varchar(60)
alto	numeric(9,3)
ancho	numeric(9,3)
largo	numeric(9,3)
tara	numeric(9,3)

TipoPale
codigo	varchar(10)
descripcion	varchar(60)
alto	numeric(9,3)
ancho	numeric(9,3)
largo	numeric(9,3)
tara	numeric(9,3)
ClasePale	ClasePale

Unidad
unidad	varchar(5)	Código de Unidad
descripcion	varchar(60)	Descripcion de la unidad