fbpx

Documentation Software VGS

Find, in our documentation, the different endpoints to which it is possible to connect to make calls or send information, facilitating real-time communication between platforms.
shape hero

API integrations benefits

APIicons easy
Easy usability

Our API quickly integrates with your key applications, delivering value right out of the box.

APIicons focus
Focused on what matters

Streamline the exchange of order, product and location information with your applications so your teams can focus on optimizing their operations.

APIicons powered
Monitored by API
Increase the visibility of your logistics operations by sharing data between your applications in real time.

Adapter API intro

Let's discover the Adapter API in less than 25 minutes.

Getting Started #

Get started by creating an account in Postman.
Then we will need to import the Postman API collection to start running each one of the API routes.

What you'll need #

You can use the Postman code generator for each route to create your API calls.
An Apikey that will be given to you by SGV Software. You can use the sandbox Apikey, that is set in the Postman documentation.

Start calling the API #

After you have all set up, you can start making calls to the Adapter API.

Important:
Remember that if you need to test in your real environment you should change the Apikey.

Further information

ApiIcon Alert

If you encounter some problem using the API you could: Use a VPN to make the calls to the API and Erase the cookies or cache that is in your browser.

Don’t hesitate to contact SGV Software if you have any questions about the use of the API

Adapter API intro

Introduction #

The adapter database is the connection between the WMS and the ERP of the company in this way, we can insert all the initial information that we need to fill our tables and get the WMS running.

Requirements #

  • You will need access to your ApiKey given to you by SGV Software.
  • Postman, to call the API and testing
  • Your programming language of preference

Getting started #

If you want to start making orders and send them to your clients with the WMS, the correct sequence to insert is:

  • Products (ART)
  • Clients (CLT)
  • Picking Header (EPK)
  • Picking Detail (DPK)

Introduction #

The products API call is made to make all the modifications related to the products that will be in the WMS.

Parameters of Products#

Name of the parameterTypeType SQLNullDescription
referenciaStringnvarcharNot NullableInternal reference or secondary code
inventariableintintNullableInventory type (0: no, 1:yes)
um1StringnvarcharNullableUnit of measure
presentacionStringnvarcharNullableProduct presentation.
costintintNullableCost
referenciaMDCStringnvarcharNullableSecondary reference or secondary code
descripcionInglesStringnvarcharNullableProduct description in English
itemStringnvarcharNullableSecondary product code
u_InvStringnvarcharNullableInventory unit
grupoStringnvarcharNullableProduct group or family
subgrupoStringnvarcharNullableProduct subgroup or brand
extension1StringnvarcharNullableProduct code variant
extension2StringnvarcharNullableProduct code variant 2
nuevoEANStringnvarcharNot NullableProduct bar code (GTIN or EAN13).
qtyEquivalentefloatdecimalNullableProduct quantity according to GTIN
origenCompraStringnvarcharNullableOrigin of the purchase
tipoStringnvarcharNullableType of product
factorfloatdecimalNullableProduct packaging quantity
f120_tipo_itemStringnvarcharNullableSecondary item or tertiary code
pesostringnvarcharNullableWeight of the article per EAN unit.
bodegaStringnvarcharNullableWarehouse where it is stored
procedenciaStringnvarcharNullableOrigin of the article (National or imported).
estadotransferenciaintintNullableTransfer status to WMS and ERP
volumenfloatdecimalNullable 
estadointintNullable 
proveedorStringnvarcharNullable 
id_tablaintintNullable 
nuevoEAN2StringnvarcharNullable 
nuevoEAN3StringnvarcharNullable 
peso_cajafloatdecimalNullable 
peso_cartonStringdecimalNullable 

CRUD of Products #

Insert

REQUEST HTTP
Use POST to call this route and remember to send the Json with them.
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 to call this route and remember to send the Json with them.
https://www.sgvsoftwareadapter.com/DELETE/TDA/WMS/ART
json.ART = {
"elementos":[
{ "productoEAN": "40512030093"}
],
"APIKEY" : "APIKEY"

};

Update

REQUEST HTTP
Use POST to call this route and remember to send the Json with them.
https://www.sgvsoftwareadapter.com/UPDATE/TDA/WMS/ART
json.ART = {
"elementos":[
{
"set": {
"preciounitario" : "1.0",
},
"where" : {
"productoEAN" : "000010462"
}

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

Select

REQUEST HTTP
Use PUT to call this route and remember to send the Json with them.


There is two versions of the SELECT, one which you can do a where statement like this:

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

};

The other version is when you do a Select for all the elements, that exist in the WMS.

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

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

Introduction #

The Client API call is made to make all the modifications related to the clients that will be in the WMS.

Parameters of Products #

Name of the parameterTypeType SQLNullDescription
nitStringnvarcharNullableCustomer’s Nit
nombreClienteStringnvarcharNullablePartner’s name
DireccionStringnvarcharNullableManagement of partner’s offices
CondicionesCompraStringnvarcharNullablePromise of delivery in days
MonedaDeFacturacionStringnvarcharNullableInvoicing currency
itemStringnvarcharNot NullableUnique customer code
ciudadStringnvarcharNullableClient’s city
departamentoStringnvarcharNullableName dispatch department
paisStringnvarcharNullableName country office
CodCiudadDestinoStringnvarcharNullableDestination city code
CodDptoDestinoStringnvarcharNullableDestination department code
CodPaisDestinoStringnvarcharNullableDestination country code
TelefonoStringnvarcharNullablePartner’s phone number
NotasStringnvarcharNullablePartner’s notes
contactoStringnvarcharNullablePartner contact name
emailStringnvarcharNullableEmail
sucursalDespachoStringnvarcharNullableBranch name dispatch
idSucursalStringnvarcharNullableBranch code
isactivoclienteintintNullableAre you active as a customer (0: no, 1: yes)?
isActivoProveedorintintNullableAre you active as a supplier (0: no, 1: yes)?
vendedorStringnvarcharNullableSeller’s information

CRUD of Clients #

Insert

REQUEST HTTP
Use POST to call this route and remember to send the Json with them.
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 to call this route and remember to send the Json with them.
https://www.sgvsoftwareadapter.com/DELETE/TDA/WMS/CLT
json.CLT = {
"elementos":[
{"item": "32342"}
],
"APIKEY" : "APIKEY"

};

Update

REQUEST HTTP
Use POST to call this route and remember to send the Json with them.
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 PUT to call this route and remember to send the Json with them.

There is two versions of the SELECT, one which you can do a where statement like this:

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

};

The other version is when you do a Select for all the elements, that exist in the WMS.

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

Introduction #

The picking header API call is made to make all the modifications related to the picking that will be in the WMS.

Parameters of Products #

Name of the parameterTypeType SQLNullDescription
tipoDoctoStringnvarcharNot NullableType of document
doctoERPStringnvarcharNot NullableDocument number
pickingStringnvarcharNot NullablePicking number (unique number).
numPedidoStringnvarcharNot NullableSecondary document number or table id
f_pedidoDatetimeDatetimeNullableDate of the original order
itemStringnvarcharNullableUnique customer code
nombreclienteStringnvarcharNullablePartner’s name
contactoStringnvarcharNullablePartner contact name
emailStringnvarcharNullableEmail
notasStringnvarcharNullableOrder notes
ciudaddespachoStringnvarcharNullableName of city of dispatch
paisDespachoStringnvarcharNullableName country of dispatch
departamentoDespachoStringnvarcharNullableName of dispatch department
sucursalDespachoStringnvarcharNullableName of dispatch branch
direccionDespachoStringnvarcharNullableDispatch address
idsucursalStringnvarcharNullableDispatch branch code
ciudadStringnvarcharNullableCity name
pedidoRelacionadoStringnvarcharNullableUnion (typeDocto – doctoERP) or secondary order.
cargueStringnvarcharNullablePlanning code for dispatch
nitintintNullableNit of the partner
fPedidoDatetimeDatetimeNullableOrder date
transportadoraStringnvarcharNullableConveyor for shipment
centroOperacionStringnvarcharNullableOperation center
estadoERPStringnvarcharNullableOrder status according to ERP
_condicionpagoStringnvarcharNullable 
_documentoReferenciaStringnvarcharNullable 
bodegaStringnvarcharNullable 
idintintNullable 
vendedor2StringnvarcharNullable 
numguiaStringnvarcharNullable 

CRUD of Picking Header #

Insert

REQUEST HTTP
Use POST to call this route and remember to send the Json with them.
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 to call this route and remember to send the Json with them.
https://www.sgvsoftwareadapter.com/DELETE/TDA/WMS/EPK
json.EPK = {
"elementos":[
{"picking": 3104}
],
"APIKEY" : "APIKEY"

};

Update

REQUEST HTTP
Use POST to call this route and remember to send the Json with them.
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 PUT to call this route and remember to send the Json with them.


There is two versions of the SELECT, one which you can do a where statement like this:

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

};


The other version is when you do a Select for all the elements, that exist in the WMS.

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

Introduction #

The picking detail API call is made to make all the modifications related to the picking details, like the products that are sending in a recollection of a picking, that will be in the WMS.

Then we will need to import the Postman API collection to start running each of the API routes.

Parameters of Products #

Name of the parameterTypeType SQLNullDescription
ReferenciaStringnvarcharNullableInternal reference
RefPadreStringnvarcharNullableParent reference
DescripcionStringnvarcharNullableProduct description.
qtyPedidodecimaldecimalNullableQuantity originally ordered
qtyReservadodecimaldecimalNullableQuantity for Product ID
productoEANStringnvarcharNot NullableMain code Product ID
pickingStringnvarcharNot NullablePicking number
LineaIdPickingintintNot NullableOrder line ID
CostodecimaldecimalNullableCost
BodegaStringnvarcharNullableWarehouse code
tipoDoctoStringnvarcharNullableType of document
doctoERPStringnvarcharNot NullableDocument number
ubicacion_planStringnvarcharNullablePlanned location
clasifartStringnvarcharNullableClassification of the article.
serialStringnvarcharNullablePartner code
itemStringnvarcharNullablePartner code
idCoStringnvarcharNullableOperations center ID
qtyRemisionadodecimaldecimalNullableQuantity shipped
qtyFacturadoStringnvarcharNullableInvoiced quantity
precioUnitariodecimaldecimalNullableUnit price of the product
notasitemStringnvarcharNullableNote of the product item
descripcionCoStringnvarcharNullableDescription of the CDO
factorintintNullableNote of the product item
numpedidoStringnvarcharNullableSecondary table number
_qtypedidabasedecimaldecimalNullableBatch wms supplier

CRUD of Picking Detail #

Insert

REQUEST HTTP
Use POST to call this route and remember to send the Json with them.
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"
};

Delete

REQUEST HTTP
Use POST to call this route and remember to send the Json with them.
https://www.sgvsoftwareadapter.com/INSERT/TDA/WMS/DPK
json.DPK = {
"elementos":[
{ "id": "562"}
],
"APIKEY" : "APIKEY"
};

Update

REQUEST HTTP
Use POST to call this route and remember to send the Json with them.
https://www.sgvsoftwareadapter.com/INSERT/TDA/WMS/DPK
json.DPK = {
"elementos":[
{ "set": { "pedproveedor": "Es necesario"},{ "where":{ "
picking": "3117"}}}
],
"APIKEY" : "APIKEY"
};

Select

REQUEST HTTP
Use PUT to call this route and remember to send the Json with them.

There is two versions of the SELECT, one which you can do a where statement like this:

https://www.sgvsoftwareadapter.com/INSERT/TDA/WMS/DPK
json.DPK = {
"elementos":[
{ "where": { "id": "110"}}
],
"APIKEY" : "APIKEY"
};