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 o /[modelo]/[código]- Ejemplo: https://200.100.100.100:8090/items/all
- Se invoca vía GET.
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.
Ejemplo de request con 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
- Ej: item/all
- Se podrá consultar por un código específico para cualquiera de los servicios de maestros
- Ej: item/123
- 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
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]
Campo | Tipo | Descripción |
---|---|---|
description | String | Descripción o nombre del canal |
code | String | Código del 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]
Campo | Tipo | Descripción |
---|---|---|
description | String | Descripción o nombre de la moneda |
codeISO | String | Código ISO de la moneda |
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]
Campo | Tipo | Descripción |
---|---|---|
code | Number | Código del tipo de identificación |
description | String | Nombre o descripción del tipo de identificación |
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]
Campo | Tipo | Descripción |
---|---|---|
code | String | Código de la ciudad |
name | String | Nombre de la ciudad |
state | String | Estado o provincia a la que pertenece la ciudad |
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]
Campo | Tipo | Descripción |
---|---|---|
code | String | Código del estado o provincia |
name | String | Nombre del estado o provincia |
country | String | País al que pertenece el estado o provincia |
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]
Campo | Tipo | Descripción |
---|---|---|
code | String | Código del país |
name | String | Nombre del país |
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"
}
Campo | Tipo | Descripción |
---|---|---|
internalCode | String | Código SKU del ítem |
description | String | Descripción del ítem |
itemDepth | Decimal | Longitud del item |
itemWidth | Decimal | Ancho del item |
itemHeight | Decimal | Altura del item |
itemGrossWeight | Decimal | Peso bruto del item |
La unidad de peso: “kg”
Para las dimensiones: “cm”
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]
Campo | Tipo | Descripción |
---|---|---|
code | String | Código de la tienda |
name | String | Nombre de la tienda |
digitalStore | Boolean | Indicador si es tienda digital o no |
address | String | Dirección de la tienda |
addressNumber | String | Número de la dirección de la tienda |
city | String | Ciudad de la tienda |
zipCode | String | Código postal de la tienda |
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]
Campo | Tipo | Descripción |
---|---|---|
code | String | Código de depósito |
name | String | Nombre del depósito |
locationStores (lista de las tiendas en las cuales se encuentra ese depósito) array | ||
store | String | Código de la Tienda a la que pertenece el depósito |
erpCode | String | Código del ERP del depósito |
disabled | Boolean | Indicador de deshabilitado |
crossSaleAllowed | Boolean | Indicador si permite la venta de otra tienda |
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]
Campo | Tipo | Descripción |
---|---|---|
code | String | Código de centro de retiro |
name | String | Nombre de centro del retiro |
address | String | Dirección del centro del retiro |
adressNumber | String | Número de la dirección del centro del retiro |
state | String | Estado o provincia del centro del retiro |
city | String | Ciudad del centro del retiro |
zipCode | String | Código postal del centro del retiro |
telephone | String | Teléfono del centro del retiro |
String | Mail del centro del retiro | |
isStore | boolean | Indicador si es o no una tienda |
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]
Campo | Tipo | Descripción |
---|---|---|
code | String | Código del medio de pago |
descriptor | String | Descripción del medio de pago |
ORDERTYPE
https://[direccion_ip]:[puerto]/orderType/all o https://[direccion_ip]:[puerto]/orderType/[código]
Campo | Tipo | Descripción |
---|---|---|
code | String | Código del tipo de orden |
name | String | Nombre del tipo de orden |
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]
Campo | Tipo | Descripción |
---|---|---|
code | String | Código del estado de un pedido |
name | String | Nombre del estado de un pedido |
description | String | Descripción del estado de un pedido |
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]
Campo | Tipo | Descripción |
---|---|---|
code | String | Código del operador logístico |
name | String | Nombre del operador logístico |
Ack
- 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 |