Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Painel
borderColor#E4E3E3
bgColor#ffffff
titleColor#ffffff
borderWidth1px
titleBGColor#704581
titleREVISIONES


Expandir
titleExpandir revisiones


FechaVersiónDescripciónAutor

1.0Creación del documento

 

1.1Se ajusta el método a POST en lugar de GET y el default resultado a 3000

 

1.2

Se actualiza servicio ítem y de precios vigentes

 

1.3

Se agrega información de imágenes al item

 

1.4

Se ajusta nota de max y skip

 

1.5

Se agregan datos al servicio item del campo url

 

1.6

Se agrega la lista de canales que pueda haberse asociado a una imagen de un item

 

1.7

Se agrega nuevo servicio brandAttribute para obtener los atributos asociados a una marca

 

1.8

Se agrega la lista de precios fijos para el servicio itemPriceCurrent (fixedPrice) 

 

1.9

Se agregan los servicios de consulta de Jerarquías y Proveedores.





Painel
borderColor#E4E3E3
titleColor#ffffff
borderWidth1
titleBGColor#704581
titleCONTENIDO


Expandir
titleExpandir contenido
Índice


...

CampoTipoDescripciónEjemplo
internalCodeStringCódigo de la tienda"internalCode": "16122022",
nameStringNombre de la tienda"name": "Artículo Crédito",
storeStringCódigo de la tienda "store": "1"
channelStringCódigo del canal"channel": "online",
originString

Origen del precio informado

"ListaPrecios"

(ó "Catalogo" para el maestro de ítems si no está en lista de precios)

"origin": "ListaPrecios",
priceNumberPrecio de venta "price": 175667,
unitCostNumberPrecio de costo"unitCost": 10,
sellingPriceListNumberNumberNro de lista de precios "sellingPriceListNumber": 99,
validFromDateFecha de validez desde "validFrom": "2022-12-19T00:00:00",    
validToDateFecha de validez hasta"validTo": "2028-01-19T23:59:59",
marginAsNumberNumberMargen (margen del precio de venta sobre el precio de costo) "marginAsNumber": 175657,
marginAsPercentNumberPorcentaje de margen (porcentaje de margen del precio de venta sobre el precio de costo)"marginAsPercent": 1756570,
barcodeString

Código de barras

(sólo si la lista de precios tuviera un código asignado)

"barcode": null,
updatedAtDate

Fecha de actualización

...


itemFixedPrices 

...

Lista 

Lista con los precios fijos que puede tener asociado un artículo

Estos son los que se hayan asociado desde Administración/artículos/precios fijos por canal

Por cada precio fijo (vigente o futuro) se informa:

  • código del artículo
  • código del canal
  • precio fijo 
  • fecha de vigencia desde
  • fecha de vigencia hasta
  • descripción del precio fijo 

 "itemFixedPrices": [

{ "internalCode": "c10",

"channelCode": "Farma",

"fixedPrice": "2500",

"validFrom": "2024-01-09T11:50:00", "validTo": "2024-01-24T15:00:00", "description": "" } ],


Bloco de código
languagejs
themeEmacs
titleEjemplo de respuesta
collapsetrue
Body
{
  "store": "1",
  "channel": "online",
  "max": 50
}

Respuesta
{
  "ack": 0,
  "data": [
    {
      "_id": "642d689eec1542a9e5b37d6b",
      "price": 175667,
      "unitCost": 10,
      "sellingPriceListNumber": 99,
      "marginAsNumber": 175657,
      "marginAsPercent": 1756570,
      "internalCode": "16122022",
      "origin": "ListaPrecios",
      "name": "Artículo Crédito",
      "validFrom": "2022-12-19T00:00:00",
      "validTo": "2028-01-19T23:59:59",
      "barcode": null,
      "channel": "online",
      "store": "1"
    }
  ]
}
  • BrandAttribute

Atributos de una marca: indica la lista de atributos de una marca 

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

Respuesta

...

"Puma"

...

"Indumentaria"

...

"Talle"

...

"XL"

...

"2023-07-17T17:54:33"

...

Bloco de código
{
    "ack": 0,
    "data": [
     "itemFixedPrices": [
                {
                    "internalCode": "c10",
                    "channelCode": "Farma",
                    "fixedPrice": {
                        "$numberDecimal": "2500"
                    {},
            "disabled": false,
            "brandDescriptionvalidFrom": "paracetamol blister x302024-01-09T11:50:00",
            "brandName": "Geniol",
            "codevalidTo": "COLOR2024-01-24T15:00:00",
            "option": "AZUL",
            "updatedAtdescription": "2023-07-17T17:54:33"
        },
        {}
            "disabled": false],
            "code  "store": "Talle1",
            "option": "XL",
            "brandDescription": "Indumentaria",
            "brandName": "Puma",
            "updatedAt": null
        }
    ]
}
  • Store

...

    }
  ]
}


...


  • BrandAttribute

Atributos de una marca: indica la lista de atributos de una marca 

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


Respuesta

...

codename tiendadigitalStore
CampoTipoDescripciónEjemplo 
brandNameStringCódigo de la tienda

"Puma"

brandDescriptionStringNombre o descripción de la
marca

"Indumentaria"

BooleanIndicador 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

...

languagejs
themeEmacs
titleEjemplo de respuesta
collapsetrue
codeStringCódigo del atributo

"Talle"

optionStringValor del atributo

"XL"

updatedAtdateFecha de actualización

"2023-07-17T17:54:33"

disabledbooleanIndicador si está habilitado o no false


Bloco de código
{
    "ack": 0,
    "data": [
        {
            "disabled": false,
            "brandDescription": "paracetamol blister x30",
            "brandName": "Geniol",
    "zipCode" : "C1221" 
     },
 	{
	"code": "onlineCOLOR",
	"name": "Bridge Online",
	"digitalStore": true,
            "addressoption": "JujuyAZUL",
     "addressNumber":"1134",
       "cityupdatedAt": "ENT123",
2023-07-17T17:54:33"
      "zipCode" : "A3215"
	}
	]
}
  • Location

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

...

,
        {
            "disabled": false,
            "code": "Talle",
            "option": "XL",
            "brandDescription": "Indumentaria",
            "brandName": "Puma",
            "updatedAt": null
        }
    ]
}



...


  • Store

TIENDA: indica la lista de tiendas que tiene configuradas BRIDGE

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

CampoTipoDescripción
codeStringCódigo de depósitola tienda
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 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


Bloco de código
languagejs
themeEmacs
titleEjemplo de respuesta
collapsetrue
{
	"ack":0,
	"data":[{ 
    "code" : "DEP11", 
    "name" : "Ventas VENTA 2UNICENTER", 
    "locationStores" :[ {
  	"digitalStore": false, 
      "storeaddress": "UnicenterVenezuela",
        "erpCode"addressNumber":"1234",
    "city": "7130ENT123",
    "zipCode" : "C1221" 
     },
 	{
	"code":  "disabled": "false",
    "online",
	"name": "Bridge Online",
	"digitalStore": true,
    "address":"Jujuy",
    "addressNumber":"1134",
    "city": "ENT123",
    "crossSaleAllowedzipCode" : "falseA3215"
	}]
}	]
}


...


  • Orderpickuplocation

    Location

CENTRO DE RETIRODEPOSITO: indica el punto o lugar de retiro de un pedido con sus datos de dirección. También puede ser una tienda la locación del depósito o warehouse donde reside el stock de los productos

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

CampoTipoDescripción
codeStringCódigo de
centro de retiro
depósito
nameStringNombre
de centro
del
retiroaddressStringDirección del centro del retiroadressNumberStringNúmero de la dirección del centro del retirostateStringEstado o provincia del centro del retirocityStringCiudad del centro del retirozipCodeStringCódigo postal del centro del retirotelephoneStringTeléfono del centro del retiromailStringMail del centro del retiroisStorebooleanIndicador si es o no una
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


Bloco de código
languagejs
themeEmacs
titleEjemplo de respuesta
collapsetrue
{
	"ack":0,
	"data":[{ 
    "code" : "Codigo1DEP1", 
    "name" : "NombreVentas VENTA 12", 
    "addresslocationStores":"Venezuela", :[ {
    "addressNumber":"1234",
    "statestore": "B123Unicenter",
        "cityerpCode": "ENT1237130",
    "zipCode" : "Codigo1",
    "telephonedisabled" : "3253265false",
    "mail": "[email protected]",
    "isStorecrossSaleAllowed" : "truefalse"
}]
}]
}


...


  • Tender

    Orderpickuplocation

MEDIO CENTRO DE PAGORETIRO: indica el medio de pago que puede tener asociado el pedido como parte de su cobranzapunto o lugar de retiro de un pedido con sus datos de dirección. También puede ser una tienda 

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

CampoTipoDescripción
codeStringCódigo
del medio de pagodescriptor
de centro de retiro
nameStringNombre de centro del retiro
addressString
Descripción del medio de pago

...

languagejs
themeEmacs
titleEjemplo de respuesta
collapsetrue

...

Direcció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


Bloco de código
languagejs
themeEmacs
titleEjemplo de respuesta
collapsetrue
{
	"ack":0,
	"data":[{ 
    "code" : "PesoCodigo1", 
    "descriptorname" : "EFECTIVONombre 1"
}
]
}
  • ORDERTYPE

...

,
    "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]/orderTypetender/all  o https://[direccion_ip]:[puerto]/orderTypetender/[código]

CampoTipoDescripción
codeStringCódigo del tipo medio de ordenpagoname
descriptorStringNombre Descripción del tipo medio de ordenpago


Bloco de código
languagejs
themeEmacs
titleEjemplo de respuesta
collapsetrue
{
	"ack":0,
	"data":[
	{ 
    	"code" : "orderPeso", 
    	"namedescriptor" : "PedidoEFECTIVO",
	}
]
}


...


  • ORDERSTATE

    ORDERTYPE

...

TIPO DE

...

ORDEN o PEDIDO: indica

...

el tipo de

...

pedido (ej: order)

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

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

description

StringDescripción del estado de un pedido
tipo de orden


Bloco de código
languagejs
themeEmacs
titleEjemplo de respuesta
collapsetrue
{
	"ack":0,
	"data":[
	{ 
    	"code" : "confirmedorder", 
    	"name" : "ConfirmadoPedido",
		"description" : "El pedido se ha confirmado en cuanto a la cantidad de productos a ingresar."
	}
]
}
  • ORDERDELIVERYCOMPANY

...


...


  • 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]/orderDeliveryCompanyorderState/all  o https://[direccion_ip]:[puerto]/orderState/[código]

CampoTipoDescripción
codeStringCódigo del operador logísticoestado de un pedido
nameStringNombre del operador logísticoestado de un pedido

description

StringDescripción del estado de un pedido


Bloco de código
languagejs
themeEmacs
titleEjemplo de respuesta
collapsetrue
{
    	"ack": 0,
    	"data": [
	{ 
    	"code" : "confirmed", {
            "code"	"name" : "AndreaniConfirmado",
		"description" : "El pedido se ha confirmado en cuanto a la  "name": "Andreani"
        }
    cantidad de productos a ingresar."
	}
]
}


...


  • TaxJurisdiction

    ORDERDELIVERYCOMPANY

Jurisdicción impositiva: indica las jurisdicciones a las que se podrá asociar una registración fiscal de un cliente del tipo empresa (organization)OPERADOR LOGISTICO: indica los diferentes distribuidores u operadores logísticos con su código, nombre y descripción.

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

de la jurisdicción de la jurisdicción
CampoTipoDescripción
codeStringCódigo del operador logístico
nameStringNombre del operador logístico


{ "ack":0, "data":[{
Bloco de código
languagejs
themeEmacs
titleEjemplo de respuesta
collapsetrue
{
    "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


Bloco de código
languagejs
themeEmacs
titleEjemplo de respuesta
collapsetrue
{
    "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


Bloco de código
languagejs
themeEmacs
titleEjemplo de respuesta
collapsetrue
{
    "ack":0,
    "data":[{
 		" jurisdictionCode" : "ARG",
	    " jurisdictionName" : "Argentina",
	    " taxTypeCode" : "IVA",
	    " taxTypeName" : "IVA",
	    " taxCategoryCode" : "RI",
	    " taxCategoryName " : "Responsable inscripto"
		}]
}
  • Supplier

Proveedores: Por medio de este servicio, se podrá consultar las distintos proveedores teniendo en cuenta los parámetros enviados:

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


Propiedad

Tipo de dato

Descripción

Requerido

code

String (25)

Código del Proveedor

No


name

String (25)

Nombre del Proveedor

No

address

String (25)

Dirección del Proveedor

No

cuit

String (25)

Identificación fiscal del Proveedor

No

email

string (25)

Email del Proveedor

No

telephone

number (25)

Teléfono del Proveedor

No

fantasyName

String (25)

Nombre de Fantasía del Proveedor

No


Ejemplo 1: Filtro por todos los proveedores

Url: http://10.4.203.65:8081/supplier/all

Bloco de código
titleEjemplo de respuesta:
linenumberstrue
collapsetrue
{
    "ack": 0,
    "data": [
        {
            "asn": false,
            "code": "1234",
            "caiRequired": false,
            "fantasyName": "Manu Proveedor",
            "automaticMail": false,
            "phone": "2234565656",              
            "cuit": "1", 
            "address": "Brown 4237",
            "name": "Manuel Repetto",
            "email": "[email protected]"
        },
        {
            "asn": false,
            "code": "456",
            "caiRequired": false,
            "automaticMail": false,
            "phone": "2234778899",
             "cuit": "37719221",  
             "address": "Mardel 1234",
            "name": "Proveedor Test",
            "email": "[email protected]"
        },
        {
            "asn": false,
            "code": "77",
            "caiRequired": false,
            "automaticMail": false,
            "phone": "2235120461",
             "cuit": "38960888",               
            "address": "Avenida Colón 1475",
            "name": "Lorena Ruiz",
            "email": "[email protected]",
            "fantasyName": "Lolo"
        }
    ]
}

...

Ejemplo 2 Filtro por un código de proveedor específico:

Url: http://10.4.203.65:8081/supplier/all

Bloco de código
titleEjemplo de request:
linenumberstrue
collapsetrue
{"code": "1234"}


Bloco de código
titleEjemplo de respuesta:
linenumberstrue
collapsetrue
{
    "ack": 0,
    "data": [
        {
            "asn": false,
            "code": "1234",
            "cuit": "32563255",
            "caiRequired": false,
            "fantasyName": "FEMSA S.A",
            "automaticMail": true,
            "phone": "3215-3253",
            "address": "Oro 9658",
            "name": "Manuel Repetto",
            "email": "[email protected]",
            "frequency": {
                "$numberDecimal": "15"
            },
            "mail": "[email protected]"
        }
    ]
}

Ejemplo 3 Filtro por un cuit específico:

Url: http://10.4.203.65:8081/supplier/all

Bloco de código
titleEjemplo de request:
linenumberstrue
collapsetrue
{"cuit": "27318219074"}


Bloco de código
titleEjemplo de respuesta:
linenumberstrue
collapsetrue
{
    "ack": 0,
    "data": [
        {
            "asn": false,
            "code": "Deshabilitado",
            "caiRequired": false,
            "automaticMail": false,
            "name": "prueba deshabilitarlo",
            "frequency": {
                "$numberDecimal": "0"
            },
            "cuit": "27318219074"
        }
    ]
}


Bloco de código
languagejs
themeEmacs
titleAutenticación
collapsetrue
Para poder realizar la consulta del servicio, es necesario generar un token.

El mismo se generará:

URL: API de Central:Puerto/auth/login

Ejemplo: http://10.4.203.65:8081/auth/login

Dentro del Body, enviaremos la siguiente consulta:
{
"clientId": "bridge-api",
"clientSecret":"DA39A3EE5E6B4B0D3255BFEF95601890AFD80709"
}

{
"clientId": "bridge-api",
"clientSecret":"DA39A3EE5E6B4B0D3255BFEF95601890AFD80709"
}
Como response, obtendremos el token que utilizaremos en la consulta de proveedores.

  • MerchandiseHierarchy

Jerarquía:  Por medio de este servicio, se podrá consultar las distintas jerarquías teniendo en cuenta los parámetros enviados:

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


Propiedad

Tipo de dato

Descripción

Requerido

code

String (25)

Código del Proveedor

No


description

String (25)

Descripción de la Jerarquía

No

levelCode

String (25)

Nivel de la Jerarquía

No


Bloco de código
languagejs
themeEmacs
titleEjemplo de request
collapsetrue
{ "code": "", "description": "", "levelCode": "1" }


Bloco de código
languagejs
themeEmacs
titleEjemplo de respuesta
collapsetrue
{
    "ack": 0,
    "data": [
        {
            "code": "H",
            "description": "Hombre",
            "disabled": false,
            "level": "Rubro",
            "children": []
        },
        {
            "code": "M",
            "description": "Mujer",
            "disabled": false,
            "level": "Rubro",
            "children": []
        },
        {
            "code": "CA",
            "description": "Con Alcohol",
            "disabled": false,
            "level": "Rubro",
            "children": []
        },
        {
            "code": "SA",
            "description": "Sin Alcohol",
            "disabled": false,
            "level": "Rubro",
            "children": []
        },
        {
            "code": "ELE",
            "description": "Electronicos",
            "disabled": true,
            "level": "Rubro",
            "children": []
        },
        {
            "code": "INF",
            "description": "Inform�tica",
            "disabled": false,
            "level": "Rubro",
            "children": []
        },
        {
            "code": "VID",
            "description": "Consolas y videojuegos",
            "disabled": false,
            "level": "Rubro",
            "children": []
        },
        {
            "code": "FFD",
            "description": "Fast Food",
            "disabled": false,
            "level": "Rubro",
            "children": []
        },
        {
            "code": "POS",
            "description": "Postres",
            "disabled": false,
            "level": "Rubro",
            "children": []
        },
        {
            "code" : "BAFYV",
         	   "namedescription" : "BuenosFrutas y Airesverduras"
	},		
	{
    "code" : "CABA",
    "name" : "CABA"
		}]
}

...

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

...

,
            "disabled": false,
            "level": "Rubro",
            "children": []
        }
    ]
}


Bloco de código
languagejs
themeEmacs
titleEjemplo de respuestaAutenticación
collapsetrue
{
    "ack":0,
    "data":[{
 		" jurisdictionCode" : "ARG",
	    " jurisdictionName" : "Argentina",
	    " taxTypeCode" : "IVA",
	    " taxTypeName" : "IVA",
	    " taxCategoryCode" : "RI",
	    " taxCategoryName " : "Responsable inscripto"
		}]
}Para poder realizar la consulta del servicio, es necesario generar un token.

El mismo se generará:

URL: API de Central:Puerto/auth/login

Ejemplo: http://10.4.203.65:8081/auth/login

Dentro del Body, enviaremos la siguiente consulta:
{
"clientId": "bridge-api",
"clientSecret":"DA39A3EE5E6B4B0D3255BFEF95601890AFD80709"
}

{
"clientId": "bridge-api",
"clientSecret":"DA39A3EE5E6B4B0D3255BFEF95601890AFD80709"
}
Como response, obtendremos el token que utilizaremos en la consulta de jerarquías.