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 via 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
https://[direccion_ip]:[puerto]/channel/all o https://[direccion_ip]:[puerto]/channel/[código]
Campo | Tipo |
---|---|
description | String |
code | String |
Currency
https://[direccion_ip]:[puerto]/currency/all o https://[direccion_ip]:[puerto]/currency/[código]
Campo | Tipo |
---|---|
description | String |
codeISO | String |
Partyidentificationtype
https://[direccion_ip]:[puerto]/partyIdentificationType/all o https://[direccion_ip]:[puerto]/partyIdentificationType/[código]
Campo | Tipo |
---|---|
code | Number |
description | String |
City
https://[direccion_ip]:[puerto]/city/all o https://[direccion_ip]:[puerto]/city/[código]
Campo | Tipo |
---|---|
code | String |
name | String |
state | String |
State
https://[direccion_ip]:[puerto]/state/all o https://[direccion_ip]:[puerto]/state/[código]
Campo | Tipo |
---|---|
code | String |
name | String |
country | String |
Country
https://[direccion_ip]:[puerto]/country/all o https://[direccion_ip]:[puerto]/country/[código]
Campo | Tipo |
---|---|
code | String |
name | String |
Item
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 items cuya fecha de última actualización sea mayor o igual a la recibida en la consulta.
{
"date": "12-8-2020"
}
Campo | Tipo |
---|---|
internalCode | String |
description | String |
itemDepth | Decimal |
itemWidth | Decimal |
itemHeight | Decimal |
itemGrossWeight | Decimal |
Store
https://[direccion_ip]:[puerto]/store/all o https://[direccion_ip]:[puerto]/store/[código]
Campo | Tipo |
---|---|
code | String |
name | String |
digitalStore | Boolean |
address | String |
addressNumber | String |
city | String |
zipCode | String |
Location
https://[direccion_ip]:[puerto]/location/all o https://[direccion_ip]:[puerto]/location/[código]
Campo | Tipo |
---|---|
code | String |
name | String |
locationStores (lista de las tiendas en las cuales se encuentra ese depósito) array | |
store | String |
erpCode | String |
disabled | Boolean |
crossSaleAllowed | Boolean |
Orderpickuplocation
https://[direccion_ip]:[puerto]/orderPickupLocation/all o https://[direccion_ip]:[puerto]/orderPickupLocation/[código]
Campo | Tipo |
---|---|
code | String |
name | String |
address | String |
adressNumber | String |
state | String |
city | String |
zipCode | String |
telephone | String |
String | |
isStore | boolean |
Tender
https://[direccion_ip]:[puerto]/tender/all o https://[direccion_ip]:[puerto]/tender/[código]
Campo | Tipo |
---|---|
code | String |
descriptor | String |
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 |