BRIDGE API - REST - Consulta de Maestros

Este documento detalla la importación de todos los maestros desde Bridge API

Se invoca de la siguiente manera: https://[direccion_ip]:[puerto]/[modelo]/all - Ejemplo: https://200.100.100.100:8090/items/all
Se invoca via POST.

Tener en cuenta:

Primero se debe invocar al servicio de autenticación para obtener un token.
Cuando se llama a cualquier servicio este token se envía como un parámetro más de la llamada en el header (x-access-token.
Si al llamar al servicio el token expiró, se recibirá respuesta de token inválido y se deberá volver a pedir uno nuevo.

Ver BRIDGE API - REST – Autenticación: token

Ejemplo de request con CURL:

CURL

curl --location --request POST 'https://200.100.100.100:8090/items/all' \
--header 'Content-Type: application/json' \
--data-raw '{
    "clientId":"bridge-api-client",
    "clientSecret":"DA39A3EE5E6B4B0D3255BFEF95601890AFD80709"
}'

items es el nombre de la entidad a consultar
clientId deben ser reemplazado por la autentificación
clientSecret deben ser reemplazado por la autentificación

Consulta: todos o por código específico

Se podrá consultar por /all obteniendo todos los registros de la entidad maestro consultada
- Ej: item/all
Se podrá consultar por un código específico para cualquiera de los servicios de maestros
- Ej: item/123
Se podrá consultar cualquiera de las entidades por todos o por su código
- /item/[code]

Descripción de las entidades:

Channel

https://[direccion_ip]:[puerto]/channel/all

Campo	Tipo
description	String
code	String

Ejemplo de respuesta

{
	"ack":0,
	"data":[{ 
    	"description" : "Canal", 
	    "code" : "canal"
	}]
}

CURRENCY

https://[direccion_ip]:[puerto]/currency/all

Campo	Tipo
description	String
codeISO	String

Ejemplo de respuesta

{
	"ack":0,
	"data":[{ 
    	"description" : "Dolar", 
	    "codeISO" : "USD"
	}]
}

PARTYIdentificationType

https://[direccion_ip]:[puerto]/partyIdentificationType/all

Campo	Tipo
code	Number
description	String

Ejemplo de respuesta

{
	"ack":0,
	"data":[{ 
    "code" : 1, 
    "description" : "DNI"
}]
}

City

https://[direccion_ip]:[puerto]/city/all

Campo	Tipo
code	String
name	String
state	String

Ejemplo de respuesta

{
	"ack":0,
	"data":[{ 
    "code" : "ENT_0136", 
    "name" : "Irazusta", 
    "state" : "BSAS"
}]
}

State

https://[direccion_ip]:[puerto]/state/all

Campo	Tipo
code	String
name	String
country	String

Ejemplo de respuesta

{
	"ack":0,
	"data":[{ 
    "code" : "BSAS", 
    "name" : "BUENOS AIRES", 
    "country" : "ARG"
}]
}

Country

https://[direccion_ip]:[puerto]/country/all

Campo	Tipo
code	String
name	String

Ejemplo de respuesta

{
	"ack":0,
	"data":[{ 
    "code" : "ARG", 
    "name" : "Argentina"
}]
}

Item

https://[direccion_ip]:[puerto]/item/all

Se podrá recibir una fecha en el body de la consulta (opcional)

Si se envía la fecha, la respuesta será de aquellos items cuya fecha de última actualización sea mayor o igual a la recibida en la consulta.

{

"date": "12-8-2020"

}

Campo	Tipo
internalCode	String
description	String
itemDepth	Decimal
itemWidth	Decimal
itemHeight	Decimal
itemGrossWeight	Decimal

Ejemplo de respuesta

{   
 "ack": 0,
    "data": [
        {
            "internalCode": "GF01",
            "description": "TV65 4K",
            "itemDepth": "220.50",
            "itemWidth": "220.50",
            "itemHeight": "220.50",
            "itemGrossWeight": "5"
        }

  ]
}

Store

https://[direccion_ip]:[puerto]/store/all

Campo	Tipo
code	String
name	String
digitalStore	Boolean
address	String
addressNumber	String
city	String
zipCode	String

Ejemplo de respuesta

{
	"ack":0,
	"data":[{ 
    "code" : "1", 
    "name" : "UNICENTER",
	"digitalStore": false, 
    "address":"Venezuela",
    "addressNumber":"1234",
    "city": "ENT123",
    "zipCode" : "C1221" 
     },
 	{
	"code": "online",
	"name": "Bridge Online",
	"digitalStore": true,
    "address":"Jujuy",
    "addressNumber":"1134",
    "city": "ENT123",
    "zipCode" : "A3215"
	}
	]
}

LOCATION

https://[direccion_ip]:[puerto]/location/all

Campo	Tipo
code	String
name	String
locationStores (lista de las tiendas en las cuales se encuentra ese depósito) array
store	String
erpCode	String
disabled	Boolean
crossSaleAllowed	Boolean

Ejemplo de respuesta

{
	"ack":0,
	"data":[{ 
    "code" : "DEP1", 
    "name" : "Ventas VENTA 2", 
    "locationStores" :[ {
        "store": "Unicenter",
        "erpCode": "7130",
        "disabled": "false",
        "crossSaleAllowed": "false"
}]
}]
}

ORDERpickuplocation

https://[direccion_ip]:[puerto]/orderPickupLocation/all

Campo	Tipo
code	String
name	String
address	String
adressNumber	String
state	String
city	String
zipCode	String
telephone	String
mail	String
isStore	boolean

Ejemplo de respuesta

{
	"ack":0,
	"data":[{ 
    "code" : "Codigo1", 
    "name" : "Nombre 1",
    "address":"Venezuela",
    "addressNumber":"1234",
    "state": "B123",
    "city": "ENT123",
    "zipCode" : "Codigo1",
    "telephone" : "3253265",
    "mail": "[email protected]",
    "isStore" : "true"
}]
}

Tender

https://[direccion_ip]:[puerto]/tender/all

Campo	Tipo
code	String
descriptor	String

Ejemplo de respuesta

{
	"ack":0,
	"data":[{ 
    "code" : "Peso", 
    "descriptor" : "EFECTIVO"
}
]
}

ack es el código de respuesta, en caso de ser un error, mirar tabla a continuación.

Código de Error	Descripción
0	El pedido ha ingresado con éxito.
9999	Error desconocido

Árvore de páginas

BRIDGE API - REST - Consulta de Maestros

Descripción de las entidades:

Channel

CURRENCY

PARTYIdentificationType

City

State

Country

Item

Store

LOCATION

ORDERpickuplocation

Tender