fbpx

Documentación Software SGV

Encuentra, en nuestra documentación, los diferentes endpoints a los cuales es posible conectarse para hacer llamados o envíos de información, facilitando la comunicación en tiempo real entre plataformas.
shape hero

Beneficios de nuestra API

APIicons easy
Fácil de Usar
Nuestra API se integra rápidamente a sus aplicaciones clave, entregando valor desde el momento de instalación
APIicons focus
Enfocado en lo Importante
Agiliza el intercambio de información de pedidos, productos y ubicaciones con sus aplicaciones para que sus equipos se enfoquen en optimizar sus operaciones
APIicons powered
Monitoreado por la API
Incremente la visibilidad de sus operaciones logísticas al compartir los datos entre sus aplicaciones en tiempo real

Introducción a la API del Integrador

Descubramos la API del adaptador en menos de 25 minutos.

Iniciando #

Comience creando una cuenta en Postman.
Luego necesitaremos importar la colección API de Postman para comenzar a ejecutar cada una de las rutas API.

Lo que necesitarás #

Puede usar el generador de código Postman para cada ruta para crear sus llamadas API.
Una Apikey que te será entregada por SGV Software. Puede usar Sandbox Apikey, que se establece en la documentación de Postman.

Empezar a llamar a la API #

Una vez que haya configurado todo, puede comenzar a realizar llamadas a la API del adaptador.

Importante:
Recuerda que si necesitas probar en tu entorno real debes cambiar el Apikey.

Más información

ApiIcon Alert
Si encuentra algún problema al usar la API puede: Usar un VPN para hacer las llamadas a la API y borra las cookies o caché que hay en su navegador.

Integrador de base de datos

Introducción #

La base de datos del adaptador es la conexión entre el WMS y el ERP de la empresa, de esta manera, podemos insertar toda la información inicial que necesitamos para completar nuestras tablas y poner en funcionamiento el WMS.

Requerimientos #

  • Necesitará acceso a su ApiKey que le entregó SGV Software.
  • Postman, para llamar a la API y testing.
  • Su lenguaje de programación de preferencia

Empezando #

Si desea comenzar a realizar pedidos y enviarlos a sus clientes con el WMS, la secuencia correcta a insertar es:
  • Products (ART)
  • Clients (CLT)
  • Picking Header (EPK)
  • Picking Detail (DPK)

Introducción #

La llamada a la API de productos se realiza para realizar todas las modificaciones relacionadas con los productos que estarán en el WMS.

Parámetros de Productos#

Nombre parámetroTipoTipo en SQLNullDescripción
referenciaStringnvarcharNot NullableReferencia interna o código secundario
inventariableintintNullableTipo inventariable (0: no, 1:si)
um1StringnvarcharNullableUnidad de medida
presentacionStringnvarcharNullablePresentacion del producto
costintintNullableCosto
referenciaMDCStringnvarcharNullableReferencia secundaria o código secundario
descripcionInglesStringnvarcharNullableDescripción en inglés del producto
itemStringnvarcharNullableCodigo secundario del producto
u_InvStringnvarcharNullableUnidad de inventario
grupoStringnvarcharNullableGrupo o familia del producto
subgrupoStringnvarcharNullableSubgrupo o marca del producto
extension1StringnvarcharNullableVariante del código del producto
extension2StringnvarcharNullableVariante 2 del código del producto
nuevoEANStringnvarcharNot NullableCódigo de barras del producto (GTIN o EAN13)
qtyEquivalentefloatdecimalNullableCantidad del producto según GTIN
origenCompraStringnvarcharNullableOrigen de la compra
tipoStringnvarcharNullableTipo del producto
factorfloatdecimalNullableCantidad de empaque del producto
f120_tipo_itemStringnvarcharNullableItem secundario o código terciario
pesostringnvarcharNullablePeso del artículo por unidad de EAN
bodegaStringnvarcharNullableBodega donde es almacenado
procedenciaStringnvarcharNullableProcedencia del artículo (Nacional o importado)
estadotransferenciaintintNullableEstado de transferencia al WMS y al ERP
volumenfloatdecimalNullable 
estadointintNullable 
proveedorStringnvarcharNullable 
id_tablaintintNullable 
nuevoEAN2StringnvarcharNullable 
nuevoEAN3StringnvarcharNullable 
peso_cajafloatdecimalNullable 
peso_cartonStringdecimalNullable 

CRUD de Productos #

Insertar

REQUEST HTTP
Use POST para llamar a esta ruta y recuerde enviar el Json con ellos.
https://www.sgvsoftwareadapter.com/INSERT/TDA/WMS/ART
json.ART = {
    "elementos" : [
        {    "productoEAN": "40512030093",
             "descripcion": "KAHLUA COFFEE LIQUEUR 750 ML - Default Title",
             "referencia": "",
             "inventariable": null,
             "um1": "unidad",
             "presentacion": "unidad",
             "costo": 19.99,
             "referenciaMDC": "",
             "descripcionIngles": "KAHLUA COFFEE LIQUEUR 750 ML - Default Title",
             "item": 42606556709069,
             "u_Inv": "lb",
             "grupo": null,
             "subgrupo": null,
             "extension1": null,
             "extension2": null,
             "nuevoEAN": "",
             "qtyEquivalente": 1,
             "origenCompra": null,
             "tipo": "",
             "factor": 1,
             "f120_tipo_item": 0.0,
             "peso": null,
             "bodega": null,
             "procedencia": null,
             "volumen": null,
             "estado": null,
             "proveedor": null,
             "id_tabla": null,
             "nuevoEAN2": null,
             "nuevoEAN3": null,
             "peso_caja": null,
             "peso_carton": null
        }
    ],
    "APIKEY" : "APIKEY"
};

Delete

REQUEST HTTP
Use POST para llamar a esta ruta y recuerde enviar el Json con ellos.
https://www.sgvsoftwareadapter.com/DELETE/TDA/WMS/ART
json.ART = {
    "elementos":[
        { "productoEAN": "40512030093"}
    ],
    "APIKEY" : "APIKEY"

};

Update

REQUEST HTTP
Use POST para llamar a esta ruta y recuerde enviar el Json con ellos.
https://www.sgvsoftwareadapter.com/UPDATE/TDA/WMS/ART
json.ART = {
     "elementos":[
         {
             "set": {
                 "preciounitario" : "1.0",
             },
             "where" : {
                 "productoEAN" : "000010462"
             }

         }
     ],
     "APIKEY" : "APIKEY"
};

Select

REQUEST HTTP
Use POST para llamar a esta ruta y recuerde enviar el Json con ellos.


Hay dos versiones de SELECT, una en la que puede hacer una instrucción where como esta:

https://www.sgvsoftwareadapter.com/SELECT/TDA/WMS/ART
json.ART = {
    "where" : {
        "productoEAN" : "562"
    },
    "APIKEY" : "APIKEY"

};


La otra versión es cuando haces un Select para todos los elementos, que existen en el WMS.

https://www.sgvsoftwareadapter.com/SELECT/TDA/WMS/ART

json.ART = {
    "APIKEY" : "APIKEY"
};

Introducción #

La llamada a la API de productos se realiza para realizar todas las modificaciones relacionadas con los productos que
estarán en el WMS.

Parámetros de Productos#

Nombre parámetroTipoTipo en SQLNullDescripción
nitStringnvarcharNullableNit del cliente
nombreClienteStringnvarcharNullableNombre del partner
DireccionStringnvarcharNullableDireccion de despachos del partner
CondicionesCompraStringnvarcharNullablePromesa de entrega en dias
MonedaDeFacturacionStringnvarcharNullableMoneda de facturacion
itemStringnvarcharNot NullableCodigo unico del cliente
ciudadStringnvarcharNullableCiudad del cliente
departamentoStringnvarcharNullableNombre departamento despacho
paisStringnvarcharNullableNombre pais despacho
CodCiudadDestinoStringnvarcharNullableCodigo de ciudad de destino
CodDptoDestinoStringnvarcharNullableCodigo de departamento de destino
CodPaisDestinoStringnvarcharNullableCodigo de pai­s de destino
TelefonoStringnvarcharNullableTelefono del partner
NotasStringnvarcharNullableNotas del partner
contactoStringnvarcharNullableNombre contacto del partner
emailStringnvarcharNullableEmail
sucursalDespachoStringnvarcharNullableNombre de sucursal despacho
idSucursalStringnvarcharNullableCodigo de sucursal
isactivoclienteintintNullable¿Se encuentra activo como cliente? (0: no, 1:si)
isActivoProveedorintintNullable¿Se encuentra activo como proveedor? (0: no, 1:si)
vendedorStringnvarcharNullableInformacion del vendedor

CRUD de Clientes #

Insertar

REQUEST HTTP
Use POST para llamar a esta ruta y recuerde enviar el Json con ellos.
https://www.sgvsoftwareadapter.com/INSERT/TDA/WMS/CLT
json.CLT = {
    "elementos":[
        {
            "nit" : null,
            "nombreCliente" : null,
            "Direccion" : null,
            "CondicionesCompra" : null,
            "MonedaDeFacturacion" : null,
            "item" : "32342",
            "ciudad" : null,
            "departamento" : null,
            "pais" : null,
            "CodCiudadDestino" : null,
            "CodDptoDestino" : null,
            "CodPaisDestino" : null,
            "Telefono" : null,
            "Notas" : null,
            "contacto" : null,
            "email" : null,
            "sucursalDespacho" : null,
            "idSucursal" : null,
            "isactivocliente" : null,
            "isActivoProveedor" : null,
            "vendedor" : null
        }
    ],
    "APIKEY" : "APIKEY"
};

Delete

REQUEST HTTP
Use POST para llamar a esta ruta y recuerde enviar el Json con ellos.
https://www.sgvsoftwareadapter.com/DELETE/TDA/WMS/CLT
json.CLT = {
    "elementos":[
        {"item": "32342"}
    ],
    "APIKEY" : "APIKEY"

};

Update

REQUEST HTTP
Use POST para llamar a esta ruta y recuerde enviar el Json con ellos.
https://www.sgvsoftwareadapter.com/UPDATE/TDA/WMS/ART
json.CLT = {
    "elementos":[
        {
             "set": {
                "nombreCliente" : "Santiago angel",
                "Direccion" : "Guillermo trujillo",
                "nit" : "1231341"
             },
             "where" : {
                "item" : "0001"
             }
        }
    ],
    "APIKEY" : "APIKEY"
};

Select

REQUEST HTTP
Use POST para llamar a esta ruta y recuerde enviar el Json con ellos.


Hay dos versiones de SELECT, una en la que puede hacer una instrucción where como esta:

https://www.sgvsoftwareadapter.com/SELECT/TDA/WMS/ART
json.CLT = {
    "where" : {
        "item" : "2155730"
    },
    "APIKEY" : "APIKEY"

};


La otra versión es cuando haces un Select para todos los elementos, que existen en el WMS.

https://www.sgvsoftwareadapter.com/SELECT/TDA/WMS/ART
json.CLT = {
    "APIKEY" : "APIKEY"
};

Introducción #

La llamada a la API de cabecera de picking se realiza para realizar todas las modificaciones relacionadas con el picking
que habrá en el WMS.

Parámetros de Productos#

Nombre parámetroTipoTipo en SQLNullDescripción
tipoDoctoStringnvarcharNot NullableTipo de documento
doctoERPStringnvarcharNot NullableNumero del documento
pickingStringnvarcharNot NullableNumero del picking (numero unico)
numPedidoStringnvarcharNot NullableNumero secundario de documento o id de tabla
f_pedidoDatetimeDatetimeNullableFecha del pedido originalmente
itemStringnvarcharNullableCodigo unico del cliente
nombreclienteStringnvarcharNullableNombre del partner
contactoStringnvarcharNullableNombre contacto del partner
emailStringnvarcharNullableEmail
notasStringnvarcharNullableNotas del pedido
ciudaddespachoStringnvarcharNullableNombre ciudad de despacho
paisDespachoStringnvarcharNullableNombre pais de despacho
departamentoDespachoStringnvarcharNullableNombre departamento de despacho
sucursalDespachoStringnvarcharNullableNombre de sucursal de despacho
direccionDespachoStringnvarcharNullableDireccion de despacho
idsucursalStringnvarcharNullableCodigo de sucursal de despacho
ciudadStringnvarcharNullableNombre ciudad
pedidoRelacionadoStringnvarcharNullableUnion (tipoDocto – doctoERP) o pedido secundario
cargueStringnvarcharNullableCodigo de planeacion para despacho
nitintintNullableNit del partner
fPedidoDatetimeDatetimeNullableFecha del pedido
transportadoraStringnvarcharNullableTransportadora para envi­o
centroOperacionStringnvarcharNullableCentro de operacion
estadoERPStringnvarcharNullableEstado del pedido segun el ERP
_condicionpagoStringnvarcharNullable 
_documentoReferenciaStringnvarcharNullable 
bodegaStringnvarcharNullable 
idintintNullable 
vendedor2StringnvarcharNullable 
numguiaStringnvarcharNullable 

CRUD de Encabezado de Selección #

Insertar

REQUEST HTTP
Use POST para llamar a esta ruta y recuerde enviar el Json con ellos.
https://www.sgvsoftwareadapter.com/INSERT/TDA/WMS/EPK
json.EPK = {
    "elementos": [
        {
            "tipoDocto": "SHPY",
            "doctoERP": 10431231,
            "numPedido": 38118647373,
            "f_pedido": "2022-01-15",
            "item": 5297663934669,
            "nombrecliente": "NIGHTLIFE BREWING COMPANY LLC BEV2307446-4COP-414",
            "contacto": "NIGHTLIFE BREWING COMPANY LLC BEV2307446-4COP-414",
            "email": null,
            "notas": null,
            "ciudaddespacho": "MIAMI",
            "paisDespacho": "US",
            "departamentoDespacho": "FL",
            "sucursalDespacho": 5297663934669,
            "direccionDespacho": "1588 NW 7TH STREET ",
            "idsucursal": 5297663934669,
            "pedidoRelacionado": null,
            "cargue": null,
            "nit": 5297663934669,
            "fPedido": "2022-01-15",
            "transportadora": "NIGHTLIFE BREWING CO",
            "centroOperacion": null,
            "estadoERP": 0,
            "_condicionpago": null,
            "_documentoReferencia": 1013,
            "bodega": "01",
            "vendedor2": null,
            "numguia": null,
            "picking" : null
        }
    ],
    "APIKEY" : "APIKEY"
};

Delete

REQUEST HTTP
Use POST para llamar a esta ruta y recuerde enviar el Json con ellos.
https://www.sgvsoftwareadapter.com/DELETE/TDA/WMS/EPK
json.EPK = {
    "elementos":[
        {"picking": 3104}
    ],
    "APIKEY" : "APIKEY"

};

Update

REQUEST HTTP
Use POST para llamar a esta ruta y recuerde enviar el Json con ellos.
https://www.sgvsoftwareadapter.com/UPDATE/TDA/WMS/EPK
json.EPK = {
    "elementos":[
        {
            "set": {
                "nombreCliente" : "Pepito",
                "nit" : "1231341"
            },
            "where" : {
                "item" : "0001"
            }

        }
],
"APIKEY" : "APIKEY"

};

Select

REQUEST HTTP
Use POST para llamar a esta ruta y recuerde enviar el Json con ellos.


Hay dos versiones de SELECT, una en la que puede hacer una instrucción where como esta:

https://www.sgvsoftwareadapter.com/SELECT/TDA/WMS/EPK
json.EPK = {
    "where" : {
       "_condicionpago": "60D"
    },
    "APIKEY" : "APIKEY"

};


La otra versión es cuando haces un Select para todos los elementos, que existen en el WMS.

https://www.sgvsoftwareadapter.com/SELECT/TDA/WMS/EPK
json.EPK = {
    "APIKEY" : "APIKEY"
};

Introducción #

La llamada a la API de detalles de selección (Picking Detail) se realiza para realizar todas las modificaciones relacionadas con los detalles de picking, como los productos que están enviando en un recuerdo de un picking, que estará en el WMS.

Luego necesitaremos importar la colección API de Postman para comenzar a ejecutar cada una de las rutas API.

Parámetros de Producto #

Nombre parámetroTipoTipo en SQLNullDescripción
ReferenciaStringnvarcharNullableReferencia interna
RefPadreStringnvarcharNullableReferencia padre
DescripcionStringnvarcharNullableDescripción del producto
qtyPedidodecimaldecimalNullableCantidad pedida originalmente
qtyReservadodecimaldecimalNullableCantidad para ID Producto
productoEANStringnvarcharNot NullableCódigo principal ID Producto
pickingStringnvarcharNot NullableNúmero de picking
LineaIdPickingintintNot NullableId de la línea del pedido
CostodecimaldecimalNullableCosto
BodegaStringnvarcharNullableCódigo de la bodega
tipoDoctoStringnvarcharNullableTipo de documento
doctoERPStringnvarcharNot NullableNúmero de documento
ubicacion_planStringnvarcharNullableUbicación planeada
clasifartStringnvarcharNullableClasificación del artículo
serialStringnvarcharNullableCódigo del partner
itemStringnvarcharNullableCódigo del partner
idCoStringnvarcharNullableID centro operaciones
qtyRemisionadodecimaldecimalNullableCantidad remisionada
qtyFacturadoStringnvarcharNullableCantidad facturada
precioUnitariodecimaldecimalNullablePrecio unitario del producto
notasitemStringnvarcharNullableNota del item de producto
descripcionCoStringnvarcharNullableDescripción del CDO
factorintintNullableNota del item de producto
numpedidoStringnvarcharNullableNúmero secundario de tabla
_qtypedidabasedecimaldecimalNullableLote proveedor del wms

CRUD de Detalle de Selección #

Insertar

REQUEST HTTP
Use POST para llamar a esta ruta y recuerde enviar el Json con ellos.
https://www.sgvsoftwareadapter.com/INSERT/TDA/WMS/DPK
json.DPK = {
    "elementos":[
        {    "Referencia" : null,
             "RefPadre" : null,
             "Descripcion" : null,
             "picking" : null,
             "qtyPedido" : null,
             "qtyReservado" : null,
             "productoEAN" : "40512030093",
             "LineaIdPicking" : 16,
             "Costo" : null,
             "Bodega" : null,
             "tipoDocto": "SHPY",
             "doctoERP": 10431231,
             "numpedido": 38118647373,
             "ubicacion_plan" : null,
             "clasifart" : null,
             "serial" : null,
             "item" : null,
             "idCo" : null,
             "qtyRemisionado" : null,
             "qtyFacturado" : null,
             "precioUnitario" : null,
             "notasitem" : null,
             "descripcionCo" : null,
             "factor" : null,
             "_qtypedidabase" : null
        }
    ],
    "APIKEY" : "APIKEY"
};

Eliminar

REQUEST HTTP
Use POST para llamar a esta ruta y recuerde enviar el Json con ellos.
https://www.sgvsoftwareadapter.com/INSERT/TDA/WMS/DPK
json.DPK = {
    "elementos":[
        {    "id": "562"}
    ],
    "APIKEY" : "APIKEY"
};