Você está vendo a versão antiga da página. Ver a versão atual.

Comparar com o atual Ver Histórico da Página

« Anterior Versão 15 Próxima »


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

  1. Se invoca de la siguiente manera: https://[direccion_ip]:[puerto]/[modelo]/all o  /[modelo]/[código]- Ejemplo: https://200.100.100.100:8090/items/all
  2. Se invoca vía GET.


Tener en cuenta:

  1. Primero se debe invocar al servicio de autenticación para obtener un token.
  2. 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.
  3.  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 GET '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]

Parámetros adicionales para las consultas

Para todos los servicios se tiene un default de cantidad de registros a devolver de los primeros 25.

Si se desea ampliar la consulta, se debe enviar como parámetro el campo "max" pudiendo combinarse con el parámetro "skip" pudiendo ir solicitando tipo paginada la respuesta. Ej: max 2000 y skip: 1 los primeros 2000 y luego con skip: 2, los otros siguientes 2000.

{
"max"2000,
"skip"1
}



Descripción de las entidades: 

  • Channel

CANAL: Indica el canal por el cual se recibe un pedido. Mediante esta entidad se podrá definir flujos de acción particular y la configuración de colas para la actualización de novedades desde BRIDGE.

https://[direccion_ip]:[puerto]/channel/all  o https://[direccion_ip]:[puerto]/channel/[código]


CampoTipoDescripción
descriptionStringDescripción o nombre del canal
codeStringCódigo del canal
Ejemplo de respuesta
{
	"ack":0,
	"data":[{ 
    	"description" : "Canal", 
	    "code" : "canal"
	}]
}
  • Currency

MONEDA: indica la moneda asociada a los medios de pago de un pedido con su código y descripción (ej.: dólar, pesos argentinos, etc.)

https://[direccion_ip]:[puerto]/currency/all o https://[direccion_ip]:[puerto]/currency/[código]

CampoTipoDescripción
descriptionStringDescripción o nombre de la moneda
codeISOStringCódigo ISO de la moneda
Ejemplo de respuesta
{
	"ack":0,
	"data":[{ 
    	"description" : "Dolar", 
	    "codeISO" : "USD"
	}]
}


  • Partyidentificationtype

TIPO DE IDENTIFICACION DE UN CLIENTE: indica el tipo de documento o identificación de un cliente con un código y descripción (ej.: DNI, pasaporte, CUIT, etc.) 

https://[direccion_ip]:[puerto]/partyIdentificationType/all o https://[direccion_ip]:[puerto]/partyIdentificationType/[código]

CampoTipoDescripción
codeNumberCódigo del tipo de identificación
descriptionStringNombre o descripción del tipo de identificación


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


  • City

CIUDAD: indica el nombre de la ciudad de la dirección de un cliente. Se informa su código, nombre y provincia/estado al que pertenece la ciudad

https://[direccion_ip]:[puerto]/city/all o https://[direccion_ip]:[puerto]/city/[código] 

CampoTipoDescripción
codeStringCódigo de la ciudad
nameStringNombre de la ciudad
stateStringEstado o provincia a la que pertenece la ciudad


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


  • State

ESTADO o PROVINCIA: indica la provincia o estado que puede venir informado en la dirección de un cliente con su código, nombre y país al que pertenece

https://[direccion_ip]:[puerto]/state/all o https://[direccion_ip]:[puerto]/state/[código]

CampoTipoDescripción
codeStringCódigo del estado o provincia
nameStringNombre del estado o provincia
countryStringPaís al que pertenece el estado o provincia
Ejemplo de respuesta
{
	"ack":0,
	"data":[{ 
    "code" : "BSAS", 
    "name" : "BUENOS AIRES", 
    "country" : "ARG"
}]
}
  • Country

PAIS: lista de países que pueden ser indicados en la dirección de un cliente

https://[direccion_ip]:[puerto]/country/all o https://[direccion_ip]:[puerto]/country/[código]

CampoTipoDescripción
codeStringCódigo del país
nameStringNombre del país
Ejemplo de respuesta
{
	"ack":0,
	"data":[{ 
    "code" : "ARG", 
    "name" : "Argentina"
}]
}
  • Item

ARTICULOS o ITEMS: SKU de los artículos del catálogo de BRIDGE informando su código, descripción y datos de dimensiones

https://[direccion_ip]:[puerto]/item/all o https://[direccion_ip]:[puerto]/item/[código]

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

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


{

"date": "12-8-2020"

}


CampoTipoDescripción
internalCodeStringCódigo SKU del ítem
descriptionStringDescripción del ítem
itemDepthDecimalLongitud del item
itemWidthDecimalAncho del item
itemHeight DecimalAltura del item
itemGrossWeightDecimalPeso bruto del item


La unidad de peso: “kg

Para las dimensiones:  “cm


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

  ]
}
  • Store

TIENDA: indica la lista de tiendas que tiene configuradas BRIDGE

https://[direccion_ip]:[puerto]/store/all o https://[direccion_ip]:[puerto]/store/[código]

CampoTipoDescripción
codeStringCódigo de la tienda
nameStringNombre de la tienda
digitalStoreBooleanIndicador si es tienda digital o no
addressStringDirección de la tienda
addressNumberStringNúmero de la dirección de la tienda
cityStringCiudad de la tienda
zipCodeStringCódigo postal de la tienda
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

DEPOSITO: indica la locación del depósito o warehouse donde reside el stock de los productos

https://[direccion_ip]:[puerto]/location/all o https://[direccion_ip]:[puerto]/location/[código]

CampoTipoDescripción
codeStringCódigo de depósito
nameStringNombre del depósito
locationStores (lista de las tiendas en las cuales se encuentra ese depósito) array
storeStringCódigo de la Tienda a la que pertenece el depósito
erpCodeStringCódigo del ERP del depósito
disabledBooleanIndicador de deshabilitado

crossSaleAllowed

BooleanIndicador si permite la venta de otra tienda
Ejemplo de respuesta
{
	"ack":0,
	"data":[{ 
    "code" : "DEP1", 
    "name" : "Ventas VENTA 2", 
    "locationStores" :[ {
        "store": "Unicenter",
        "erpCode": "7130",
        "disabled": "false",
        "crossSaleAllowed": "false"
}]
}]
}
  • Orderpickuplocation

CENTRO DE RETIRO: indica el punto o lugar de retiro de un pedido con sus datos de dirección. También puede ser una tienda 

https://[direccion_ip]:[puerto]/orderPickupLocation/all o https://[direccion_ip]:[puerto]/orderPickupLocation/[código]

CampoTipoDescripción
codeStringCódigo de centro de retiro
nameStringNombre de centro del retiro
addressStringDirección del centro del retiro
adressNumberStringNúmero de la dirección del centro del retiro
stateStringEstado o provincia del centro del retiro
cityStringCiudad del centro del retiro
zipCodeStringCódigo postal del centro del retiro
telephoneStringTeléfono del centro del retiro
mailStringMail del centro del retiro
isStorebooleanIndicador si es o no una tienda
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

MEDIO DE PAGO: indica el medio de pago que puede tener asociado el pedido como parte de su cobranza

https://[direccion_ip]:[puerto]/tender/all  o https://[direccion_ip]:[puerto]/tender/[código]

CampoTipoDescripción
codeStringCódigo del medio de pago
descriptorStringDescripción del medio de pago
Ejemplo de respuesta
{
	"ack":0,
	"data":[{ 
    "code" : "Peso", 
    "descriptor" : "EFECTIVO"
}
]
}
  • ORDERTYPE

TIPO DE ORDEN o PEDIDO: indica el tipo de pedido (ej: order)

https://[direccion_ip]:[puerto]/orderType/all  o https://[direccion_ip]:[puerto]/orderType/[código]

CampoTipoDescripción
codeStringCódigo del tipo de orden
nameStringNombre del tipo de orden
Ejemplo de respuesta
{
	"ack":0,
	"data":[
	{ 
    	"code" : "order", 
    	"name" : "Pedido",
	}
]
}
  • ORDERSTATE

ESTADO DE UNA ORDEN o PEDIDO: indica los diferentes estados de un pedido con su código, nombre y descripción

https://[direccion_ip]:[puerto]/orderState/all  o https://[direccion_ip]:[puerto]/orderState/[código]

CampoTipoDescripción
codeStringCódigo del estado de un pedido
nameStringNombre del estado de un pedido

description

StringDescripción del estado de un pedido
Ejemplo de respuesta
{
	"ack":0,
	"data":[
	{ 
    	"code" : "confirmed", 
    	"name" : "Confirmado",
		"description" : "El pedido se ha confirmado en cuanto a la cantidad de productos a ingresar."
	}
]
}
  • ORDERDELIVERYCOMPANY

OPERADOR LOGISTICO: indica los diferentes distribuidores u operadores logísticos con su código, nombre y descripción.

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

CampoTipoDescripción
codeStringCódigo del operador logístico
nameStringNombre del operador logístico


Ejemplo de respuesta
{
    "ack": 0,
    "data": [
        {
            "code": "Andreani",
            "name": "Andreani"
        }
    ]
}
  • TaxJurisdiction

Jurisdicción impositiva: indica las jurisdicciones a las que se podrá asociar una registración fiscal de un cliente del tipo empresa (organization)

https://[direccion_ip]:[puerto]/taxJurisdiction/all  o https://[direccion_ip]:[puerto]/taxJurisdiction/[código]

Campo

Tipo

Descripción

code

String

Código de la jurisdicción

name

String

Nombre de la jurisdicción

Ejemplo de respuesta
{
    "ack":0,
    "data":[{
	    "code" : "BA",
    	"name" : "Buenos Aires"
	},		
	{
    "code" : "CABA",
    "name" : "CABA"
		}]
}
  • TaxJurisdictionTaxType

Categoría impositiva: indica las diferentes categorías impositivas jurisdicciones a las que se podrá asociar una registración fiscal de un cliente del tipo empresa (organization)

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

 

Campo

Tipo

Descripción

jurisdictionCode

String

Código de la jurisdicción

jurisdictionName

String

Nombre de la jurisdicción

taxTypeCode

String

Código del tipo de impuesto (IB o IVA)

 

taxTypeName

String

Nombre del tipo de impuesto

taxCategoryCode

String

Código de categoría impositiva

taxCategoryName

String

Nombre de la categoría impositiva

Ejemplo de respuesta
{
    "ack":0,
    "data":[{
 		" jurisdictionCode" : "ARG",
	    " jurisdictionName" : "Argentina",
	    " taxTypeCode" : "IVA",
	    " taxTypeName" : "IVA",
	    " taxCategoryCode" : "RI",
	    " taxCategoryName " : "Responsable inscripto"
		}]
}


  • Sem rótulos