Versões comparadas

Chave

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

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



Índice


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

...

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"

}

...

La unidad de peso: “kg


...

Se agrega un nuevo parámetro para obtener más información del ítem. Si no se envía el parámetro o se envía = false, solo se informarán los primeros campos del item (internalCode, description y datos de dimensión del item) 

Disponible a partir de v7.4

 {
"moreDetail"true
}


CampoTipoDescripciónEjemplo
internalCodeStringCódigo SKU del ítem

"internalCode""C123456",

descriptionStringDescripción del ítem

"description""Articulo C123456",

itemDepthDecimalLongitud del ítem

 "itemDepth""0",

itemWidthDecimalAncho del ítem

"itemWidth""0",

itemHeight DecimalAltura del ítem

"itemHeight""0",

itemGrossWeightDecimalPeso bruto del ítem

"itemGrossWeight""0",

disabledBooleanIndica si se encuentra deshabilitado

 "disabled"false,


notForSaleBooleanIndicador de si está disponible para la venta

"notForSale"false,

discountsNotAllowedBooleanIndicador si permite recibir descuentos 

"discountsNotAllowed"false,

priceRequiredBooleanIndicador si requiere el ingreso de precio al ser vendido

"priceRequired"false,

sellerRequiredBooleanIndicador si requiere el ingreso del vendedor

"sellerRequired"false,


magnitudeRequiredBooleanIndicador si requiere el ingreso de la magnitud/peso

"magnitudeRequired"false,

quantityRequiredBooleanIndicador si requiere el ingreso de la cantidad a vender

"quantityRequired"false,

quantityAllowedBooleanIndicador si permite la venta por cantidad

"quantityAllowed"true,

restrictedSalesHourBooleanIndicador si no se permite su venta en horario restringido 

 "restrictedSalesHour"true,

recordInExceptionLogBooleanIndica si se guarda su venta en el log de excepciones 

"recordInExceptionLog"false,

authorizationRequiredBooleanIndica si su venta requiere de autorización del supervisor

"authorizationRequired"false,

foodStampTenderBooleanIndica si aplica para pago con cupones de alimento

 "foodStampTender"false,

serialNumberRequiredBooleanIndica si requiere del nro de serie

"serialNumberRequired"false,

refundNotAllowedBooleanIndica si permite su devolución

 "refundNotAllowed"false,

genericItemBooleanIndica si es un item del tipo genérico (solo utilizado para items de recargo)

"genericItem"false,

fullDescriptionStringDescripción extendida "fullDescription""Articulo C123456 con atributos",
kitComponentBooleanIndica si es un componente de un kit (hijo) 

 "kitComponent"false,

stockReservationRequiredBooleanIndica si requeire reserva de stock (para validar si tiene stock teórico para su venta y deja registro de su reserva) 

 "stockReservationRequired"false,

importDocReqBooleanIndica si requiere lote o despacho
pricenumberDecimalPrecio de venta del maestro

 "price""525.0000",

promotionalPricenumberDecimalPrecio promocional

"promotionalPrice""0.0000",

promotionalPriceStartdateVigencia inicio de precio promocional

"promotionalPriceStart""1969-12-31T00:00:00",

promotionalPriceEnddateVigencia fin de precio promocional

"promotionalPriceEnd""1969-12-31T00:00:00",

unitCostnumberDecimalPrecio de costo

 "unitCost""230.0000",

updatedAtdateFecha de ultima actualización

 "updatedAt""2023-03-30T14:47:55",


ivaTypeStringCódigo del tipo de iva

"ivaType""2",

itemType


calculateCommisionBooleanIndicador si calcula comisión

"calculateCommission"false,


detailedDescriptionStringDescripción detallada

 "detailedDescription""Articulo C123456 con atributos",


unitOfMeasureStringCódigo de la unidad de medida

"unitOfMeasure""u",

locationStringCódigo del depósito

  "location""DEP1",


taxCategoryStringCódigo de categoría de impuestos (para percepciones de IVA o IB en Argentina) 

 "taxCategory""G",

hierarchyGroup

StringCódigo de la categoría departamental

"hierarchyGroup""ALMA",


brand

StringCódigo de la marca

 "brand""MERCEDES",


relevance

NumberRelevancia (para el ordenamiento en búsquedas)

"relevance"1,


supplier

StringCódigo del proveedor

"supplier""37719221",


manufacturer

StringCódigo del fabricante

 "manufacturer""FAB1"


published

BooleanIndica si se publica o no (no está en uso) 

 "published"true,


upc

StringCódigo universal de producto (utilizado para agrupar artículos que suman para la lista de precios mayoristas)

"upc""C123",

exemptFlagBooleanIndica si es un item exento de impuestos "exemptFlag"false,
maxStockNumberCantidad máxima de stock (para pedido sugerido)

"maxStock""100",     

securituStockNumberCantidad de stock de seguridad (para pedido sugerido) 

"securityStock""5",

blockedForIcdBooleanIndica si se encuentra bloqueado para compras en docs de inventario

 "blockedForIcd"true,


requiresPrescriptionFlagBooleanIndica si requiere receta (vertical farmacia)

  "requiresPrescriptionFlag"false,

stockItemListaIndica si es un ítem que maneja stock y sus características

"stockItem": {
                "looseWeight""false",
                "itemDepth""0",
                "itemHeight""0",
                "itemNetWeight""0",
                "itemCost""0",
                "gainWeight""false",
                "baseCost""0",
                "unitsPerSellingUnit""0",
                "itemGrossWeight""0",
                "itemDiameter""0",
                "itemDrainedWeight""0",
                "itemWidth""0",
                "netCost""0",
                "availableDate""Tue Mar 28 2023 19:12:34 GMT-0300 (hora estándar de Argentina)"
            }

attributes:

[           

],

Lista

Lista de atributos conteniendo por cada uno:

  • código del atributo
  • nombre del atributo
  • flag si puede ser editado en el POS
  • opción o valor del atributo para el artículo 

"attributes": [
                {
                    "code": "23001",
                    "name": "Envase de plástico",
                    "editOptionsFlag": true,
                    "option": "true"
                },             
                {
                    "code": "Rec",
                    "name": "Receta",
                    "editOptionsFlag": true,
                    "option": "true"
                }
            ]

barcode: [

            ],

Lista

Lista de códigos de barra asociados al item

 "barcode": [
                "77123456789",
                "77111111111",
                "44332211"
            ],


Informações

La unidad de peso: “kg

Para las dimensiones:  “cm


Bloco de código
languagejs
themeEmacs
titleEjemplo de respuesta
collapsetrue
{   
 "ack": 0,
    "data": [
        {
            "internalCode": "GF01",
            "description": "TV65 4K",
            "itemDepth": "220.50",
            "itemWidth": "220.50",
            "itemHeight": "220.50",
            "itemGrossWeight": "5"
        }

  ]
}


Ejemplo de respuesta con el parámetro "moreDetail"true

Bloco de código
languagejs
themeEmacs
titleEjemplo de respuesta
collapsetrue
{
    "ack": 0,
    "data": [
        {
            "attributes": [
                {
                    "code": "23001",
                    "name": "Envase de plástico",
                    "editOptionsFlag": true,
                    "option": "true"
                },
                {
                    "code": "23006",
                    "name": "Fecha de envase",
                    "editOptionsFlag": true,
                    "option": "2022-10-01"
                },
                {
                    "code": "23008",
                    "name": "Laboratorio",
                    "editOptionsFlag": true,
                    "option": "Gador"
                },
                {
                    "code": "Rec",
                    "name": "Receta",
                    "editOptionsFlag": true,
                    "option": "true"
                }
            ],
            "internalCode": "C123456",
            "description": "Articulo C123456",
            "price": "525.0000",
            "unitCost": "230.0000",
            "updatedAt": "2023-03-30T14:47:55",
            "disabled": false,
            "notForSale": false,
            "discountsNotAllowed": false,
            "priceRequired": false,
            "sellerRequired": false,
            "magnitudeRequired": false,
            "quantityRequired": false,
            "quantityAllowed": true,
            "restrictedSalesHour": true,
            "recordInExceptionLog": false,
            "authorizationRequired": false,
            "foodStampTender": false,
            "serialNumberRequired": false,
            "refundNotAllowed": false,
            "kitComponent": false,
            "stockReservationRequired": false,
            "genericItem": false,
            "fullDescription": "Articulo C123456 con atributos",
            "promotionalPrice": "0.0000",
            "calculateCommission": false,
            "detailedDescription": "Articulo C123456 con atributos",
            "unitOfMeasure": "u",
            "ivaType": "2",
            "location": "DEP1",
            "taxCategory": "G",
            "itemDepth": "0",
            "itemWidth": "0",
            "itemHeight": "0",
            "itemGrossWeight": "0",
            "hierarchyGroup": "ALMA",
            "brand": "MERCEDES",
            "relevance": 1,
            "supplier": "37719221",
            "published": true,
            "upc": "C123",
            "exemptFlag": false,
            "maxStock": "100",
            "securityStock": "5",
            "blockedForIcd": true,
            "requiresPrescriptionFlag": false,
            "manufacturer": "FAB1",
            "barcode": [
                "77123456789",
                "77111111111",
                "44332211"
            ],
            "stockItem": {
                "looseWeight": "false",
                "itemDepth": "0",
                "itemHeight": "0",
                "itemNetWeight": "0",
                "itemCost": "0",
                "gainWeight": "false",
                "baseCost": "0",
                "unitsPerSellingUnit": "0",
                "itemGrossWeight": "0",
                "itemDiameter": "0",
                "itemDrainedWeight": "0",
                "itemWidth": "0",
                "netCost": "0",
                "availableDate": "Tue Mar 28 2023 19:12:34 GMT-0300 (hora estándar de Argentina)"
            }
        }
    ]
}


...


  • itemPriceCurrent 

Precios vigentes: informa los precios vigentes para una tienda/canal según fuera obtenido por el servicio "itemPriceBuildProcess"

Disponible a partir de v7.4

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

En el body se deberá informar al menos uno de los dos datos requeridos: store y/o channel (código de tienda y/o código de canal) 

  • Si se solicita store, se informarán aquellos precios vigentes de los artículos de esa tienda (según lo informado en el reporte de precios vigentes, tabla itemPriceCurrent)
  • Si se solicita channel, se informarán aquellos precios vigentes de los artículos de ese canal para toda tienda (según lo informado en el reporte de precios vigentes, tabla itemPriceCurrent)
  • Si se solicita store y channel, se informarán aquellos precios vigentes de los artículos de ese canal para esa tienda (según lo informado en el reporte de precios vigentes, tabla itemPriceCurrent)
  • Se recomienda el uso de los parámetros max y skip (por el volumen de información que pudiera devolver) 


{
  "store": "1", 
  "channel": "online",
  "max": 5000, 

   "skip"1
}


Informações
titleParámetros adicionales para las consultas

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

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
}


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



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": "GF0116122022",
      "origin": "ListaPrecios",
      "name": "Artículo        "descriptionCrédito",
      "validFrom": "TV65 4K2022-12-19T00:00:00",
            "itemDepth      "validTo": "220.502028-01-19T23:59:59",
            "itemWidth      "barcode": "220.50",
            "itemHeightnull,
      "channel": "220.50online",
            "itemGrossWeight      "store": "51"
            }

   ]
}



...


  • Store

TIENDA: indica la lista de tiendas que tiene configuradas BRIDGE

...

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


Bloco de código
languagejs
themeEmacs
titleEjemplo de respuesta
collapsetrue
{
	"ack":0,
	"data":[
	{ 
    	"code" : "order", 
    	"name" : "Pedido",
	}
]
}

...

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


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

...

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

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


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

...

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"
		}]
}

...

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"
		}]
}

...