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

Descripción de las entidades:

Currency

Campo	Tipo
description	String
codeISO	String
symbol	String
decimalQty	Number
disabled	Boolean

Ejemplo de respuesta

{
	"ack":0,
	"data":[{ 
	    "_id" : "5ea5565c5604c8593c608311", 
    	"description" : "Dolar", 
	    "codeISO" : "USD", 
	    "symbol" : "US$", 
	    "disabled" : false, 
	    "decimalQty" : 2
	}]
}

IdentificationType

Campo	Tipo
code	Number
description	String

Ejemplo de respuesta

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

City

Campo	Tipo
code	String
name	String
state	iState

Ejemplo de respuesta

{
	"ack":0,
	"data":[{ 
    "_id" : "5eda80976826f278af2e0e43", 
    "code" : "ENT_0136", 
    "name" : "Irazusta", 
    "state" : "5ea556565604c8593c602e8c"
}]
}

State

Campo	Tipo
code	String
name	String
country	iCountry

Ejemplo de respuesta

{
	"ack":0,
	"data":[{ 
    "_id" : "5ea556565604c8593c602e86"
    "code" : "BSAS", 
    "name" : "BUENOS AIRES", 
    "country" : "5ea556565604c8593c602e7a"
}]
}

Country

Campo	Tipo
code	String
name	String

Ejemplo de respuesta

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

Item

Campo	Tipo
internalCode	String
description	String
fullDescription	String
detailedDescription	String
hierarchyGroup	iMerchandiseHierarchyGroup['_id']
brand	iBrand['_id']
supplier	iSupplier['_id']
itemType	iItemType['_id']
price	Number
specialPrice	Number
unitCost	Number
ivaType	iItemIvaType['_id']
notForSale	Boolean
discountsNotAllowed	Boolean
priceRequired	Boolean
sellerRequired	Boolean
magnitudeRequired	Boolean
quantityRequired	Boolean
quantityAllowed	Boolean
restrictedSalesHour	Boolean
recordInExceptionLog	Boolean
authorizationRequired	Boolean
foodStampTender	Boolean
serialNumberRequired	Boolean
refundNotAllowed	Boolean
promotionalPrice	Number
promotionalPriceStart	Date
promotionalPriceEnd	Date
unitOfMeasure	iUnitOfMeasure['_id']
lastSalesPriceUpdate	Date
genericItem	Boolean
kitComponent	Boolean
commissionPercent	Number
disabled	Boolean
secondUnitOfMeasure	iUnitOfMeasure['_id']
location	iLocation['_id']
taxCategory	iItemTaxCategory['_id']
stockReservationRequired	Boolean
importDocReq	Boolean
calculateCommission	Boolean
peProfit	Number
relevance	Number
oldPrice	Number
published	Number
product	iProduct['_id']
flagIndexed	Boolean
itemUserData	any
stockItem	[any]
aggregateItem	[any]
internalTaxes	[any]
linkedItems	[any]

Ejemplo de respuesta

{
	"ack":0,
	"data":[{ 
    "_id" : "5ea5565c5604c8593c6083f8", 
    "notForSale" : true, 
    "discountsNotAllowed" : false, 
    "priceRequired" : true, 
    "magnitudeRequired" : false, 
    "quantityRequired" : false, 
    "quantityAllowed" : true, 
    "restrictedSalesHour" : false, 
    "recordInExceptionLog" : false, 
    "authorizationRequired" : false, 
    "foodStampTender" : false, 
    "serialNumberRequired" : false, 
    "refundNotAllowed" : false, 
    "genericItem" : false, 
    "kitComponent" : false, 
    "stockReservationRequired" : false, 
    "importDocReq" : false, 
    "flagIndexed" : true, 
    "internalCode" : "WRTY", 
    "description" : "Garantia Extendida", 
    "price" : NumberDecimal("0", 
    "unitCost" : NumberDecimal("0", 
    "ivaType" : "5ea5565c5604c8593c6081ec", 
    "itemType" : "5ea556595604c8593c607f07", 
    "unitOfMeasure" : "5ea5565c5604c8593c6081f0", 
    "lastSalesPriceUpdate" : "2016-06-20T03:00:00.000+0000", 
    "disabled" : false, 
    "taxCategory" : "5ea5565c5604c8593c6081fd", 
    "product" : "5ea5565c5604c8593c6083c1", 
    "sellerRequired" : false, 
    "location" : "5ea5565b5604c8593c6081a3"
}]
}

Store

Campo	Tipo
code	String
name	String
address	String
telephone	String
mail	String
timezone	String
zipCode	String
city	iCity['_id']
t2ACode	String
storeTaxCategory	iStoreTaxCategory['_id']
taxJurisdictionTaxTypeCategory	iTaxJurisdictionTaxTypeCategory['_id']
agenteRetencion	Boolean
company	iCompany['_id']
plant	String
cdiPercentage	Number
size	Number
sellingAreaSize	Number
stockCode	Number
format	iFormat['_id']
storeChain	iStoreChain['_id']
subZone	iSubzone['_id']
zone	iZone['_id']
erpFlag	Boolean
web	String
storeBarcodeConfig	[any]
regions	[any]

Ejemplo de respuesta

{
	"ack":0,
	"data":[{ 
    "_id" : "5ef0a752b9c52d33f04219ef", 
    "erpFlag" : false, 
    "code" : "1", 
    "name" : "UNICENTER", 
    "stockCode" : 3982, 
    "taxJurisdictionTaxTypeCategory" : "5ea556595604c8593c607ec2", 
    "agenteRetencion" : true, 
    "company" : "5ea5565a5604c8593c607f36"
}

]
}

Location

Campo	Tipo
code	String
erpCode	String
name	String
saleAllowed	Boolean
disabled	Boolean
distributionCenter	Boolean
revenueCenter	iRevenueCenter['_id']
itemInventoryState	iItemInventoryState['_id']
storeCode	String
printer	iPrinter['_id']
requiresStockVerification	Boolean
locationStores	[any]

Ejemplo de respuesta

{
	"ack":0,
	"data":[{ 
    "_id" : "5ea5565b5604c8593c6081a3", 
    "code" : "DEP1", 
    "name" : "Ventas (VENTA 2", 
    "saleAllowed" : true, 
    "disabled" : false, 
    "distributionCenter" : false, 
    "revenueCenter" : "5ea5565b5604c8593c6081a2", 
    "itemInventoryState" : "5ea556525604c8593c60270a", 
    "requiresStockVerification" : false, 
    "erpCode" : "VENTA2", 
    "id" : "5ea5565b5604c8593c6081a3", 
    "stockVerificationReqFlag" : false
}

]
}

Tender

Campo	Tipo
code	String
tenderType	iTenderType['_id']
descriptor	String
disabled	Boolean

Ejemplo de respuesta

{
	"ack":0,
	"data":[{ 
    "_id" : "5ea5565d5604c8593c60841f", 
    "code" : "Peso", 
    "descriptor" : "EFECTIVO", 
    "tenderType" : "5ea556595604c8593c607ed3", 
    "disabled" : false
}
]
}

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:

Currency

IdentificationType

City

State

Country

Item

Store

Location

Tender