# UES Postal

# 1. Consultar stock

GET /api/products

Devuelve un array con el stock de productos disponibles.

REQUEST

La siguiente información va en el header:

provider: Nombre del OOLL ("UES Postal"). Campo obligatorio
user: Usuario provisto por UES Postal. Campo obligatorio.
pass: Password provisto por UES Postal. Campo obligatorio.

provider: UES Postal
user: TEST5
pass: TEST5.ABC

RESPONSE

[
    {
    "codProd": "001XYZ1234",
    "descProd": "DESCRIPCION DEL ARTICULO XYZ1234",
    "cantStock": 9 
    },
    ...
    {
    "codProd": "001XYZ4567",
    "descProd": " DESCRIPCION DEL ARTICULO XYZ4567",
    "cantStock": 12
    }
]

# 2. Listar sucursales

GET /api/subsidiary

El método devuelve un listado de las sucursales habilitadas para pickup.

REQUEST

Los campos van en el header.

provider: UES Postal.
user: Usuario. Campo obligatorio.
pass: Password. Campo obligatorio.

provider: UES Postal
user: TEST5
pass: TEST5.ABC

RESPONSE

Devuelve un array de las sucursales disponibles para retirar el pedido.

[
    {
    "internalId": "252", // código de pickup. Se utiliza cuando la forma de envío del servicio es RETIRAN
    "descripcion": "UES Suc. 036",
    "departamento": "Artigas",
    "localidad": "Artigas",
    "direccion": "Wilson Ferreira 340"
    },
    ...
    {
    "internalId": "425",
    "descripcion": "UES Xpres! 071 - Estación Ancap",
    "departamento": "Treinta y Tres",
    "localidad": "Treinta Y Tres",
    "direccion": "Ruta 8 Km. 285,000"
    }
]

# 3. Generar Envío / Pick Up / Etiqueta

POST /api/shipping/create

El método permite generar un envío.

REQUEST

# provider_data

provider: (Tipo de dato: string). Nombre del OOLL (UES Postal). Campo obligatorio.
USER: (Tipo de dato: string). Usuario para creación de envío provisto por UES Postal. Campo obligatorio.
PASS: (Tipo de dato: string). Password para creación de envío provisto por UES Postal. Campo obligatorio.
API_KEY: (Tipo de dato: string). Número de cliente provisto por UES Postal. Campo obligatorio.
API_SECRET: (Tipo de dato: string). Token provisto por UES Postal. Campo obligatorio.
USER2: (Tipo de dato: string). Usuario para ingreso de pedidos provisto por UES Postal. Campo obligatorio.
PASS2: (Tipo de dato: string). Password para ingreso de pedidos provisto por UES Postal. Campo obligatorio.

# shippment_data

id_externo: (Tipo de dato: string) Order Id. Debe identificar al pedido como único. Campo obligatorio.
tipoServicio: (Tipo de dato: string) El tipo de servicio en el que se debe realizar la entrega. Campo obligatorio. Las opciones son:
- Entrega en Pick Up: 2519
- Entrega Pick Up Interior - Xpres: 11963
- UES 3 Dias - 72 Horas: 3118
- UES 3 Dias - 72 Horas Interior: 12176
- UES Estandar - 24 Horas: 2110
- UES Estandar - 24 Horas - INT: 31443
destino.sucursal.id: (Tipo de dato: string). Id de la sucursal correspondiente obtenido en el método Consultar sucursales. Campo obligatorio si el tipoServicio es pickup.
bultos.cantidad: (Tipo de dato: string). Cantidad de bultos que componen en el envío. Campo opcional.
bultos.kilos: (Tipo de dato: string). Peso total del envío. Campo opcional.
bultos.valorDeclaradoConImpuestos: (Tipo de dato: string). Costo de la mercadería transportada, en caso de siniestro es por este valor que se asegura la mercadería. Campo opcional.
fecha_alta: (Tipo de dato: string) indica el horario en que se pactó o se encuentra el destinatario en su domicilio, el formato es el siguen “09:00 AM a 06:00 PM” el rango horario no puede ser menor a 3 horas. Campo obligatorio.
destinatario.nombreCompleto: (Tipo de dato: string) Nombre y apellido del destinatario. Campo obligatorio.
destinatario.email: (Tipo de dato: string) email del destinatario. Campo obligatorio.
destinatario.telefonos: (Tipo de dato: string) teléfonos del destinatario. Campo obligatorio.
destino.postal.calle: (Tipo de dato: string). Campo obligatorio.
destino.postal.numero: (Tipo de dato: string). Campo obligatorio.
destino.postal.piso: (Tipo de dato: string). Campo obligatorio.
destino.postal.departamento: (Tipo de dato: string). Campo obligatorio.
destino.postal.localidad: (Tipo de dato: string). Campo obligatorio.
destino.postal.region: (Tipo de dato: string). Campo obligatorio.
destino.postal.codigoPostal: (Tipo de dato: string). Campo obligatorio.
destino.postal.entreCalle: (Tipo de dato: string). Observaciones sobre el destino. Campo opcional.
item.cantidad: (Tipo de dato: string). Cantidad de unidades de producto que se enviará. Campo obligatorio.
item.sku: (Tipo de dato: string). SKU producto que se enviará. Campo obligatorio.

{
    "provider_data": {
        "provider": "UES Postal",
        "API_KEY": "20470", 
        "API_SECRET": "t3st1ng3", 
        "USER": "test", 
        "PASS": "test_ues_921",
        "USER2": "TEST5", 
        "PASS2": "TEST5.ABC"
    },
    "shippment_data": {
        "origen": {
            "postal": {
                "codigoPostal": "",
                "calle": "",
                "numero": "",
                "piso": "",
                "departamento": "",
                "localidad": "",
                "region": "",
                "pais": "",
                "entreCalle": ""
            }
        },
        "fecha_alta": "",
        "tipoServicio": "31443",
        "tipo_paquete": "",
        "id_externo": "WA234567",
        "modalidad_envio": "",             
        "direccion_envio": "",                                                             
        "correo": "", 
        "currency": "",
        "type": "",
        "flow": "",
        "valor_envio": "",
        "destino": {
            "sucursal": {
                "id": ""
            },
            "postal": {
                "codigoPostal": "55000",
                "calle": "CALLE NAPO 1138, POR EL COLISEO CERRADO DE IQUITOS",
                "numero": "1602",
                "piso": "1",
                "departamento": "C",
                "localidad": "Artigas",
                "colonia": "",
                "region": "Artigas",
                "pais": "",
                "entreCalle": "Info complementaria"
            }
        },
        "remitente": {
            "nombreCompleto": "",
            "email": "",
            "documentoTipo": "",
            "documentoNumero": "",
            "telefonos": ""
        },
        "destinatario": {
            "nombreCompleto": "Garrafa Sánchez",
            "email": "destinatario@andreani.com",
            "documentoTipo": "",
            "documentoNumero": "",
            "telefonos": "1112345678"
        },
        "productoAEntregar": "",
        "bultos": {
            "cantidad":1,
            "kilos": 2,
            "largoCm": 10,
            "altoCm": 50,
            "anchoCm": 10,
            "volumenCm": 5000,
            "valorDeclaradoSinImpuestos": 1200,
            "valorDeclaradoConImpuestos": 1452,
            "detalle": "Secador de pelo",
            "idCliente": "10000"
        },
        "items": [{
            "cantidad": "1",
            "kilos": "",
            "largoCm": "",
            "altoCm": "",
            "anchoCm":"",
            "volumenCm": "",
            "valorContraReembolso": "",
            "valorDeclaradoConImpuestos": "",
            "sku": "995ARTIC1",
            "descripcion": ""
        }]
    }
}

RESPONSE

numeroDeEnvio: Número de tracking.
guia: Número de guía. Se utilizará para obtener el tracking.
etiqueta: url de la etiqueta.

{
    "response": "Success",
    "providerStatus": "Creado",
    "numeroDeEnvio": "UESCOM1696421781831",
    "guia": "UES1696421783170",
    "sucursalDeDistribucion": {
        "id": null,
        "descripcion": ""
    },
    "sucursalDeRendicion": null,
    "sucursalDeImposicion": null,
    "numeroDePermisionaria": null,
    "descripcionServicio": "",
    "etiqueta": "https://sge.ues.com.uy:9443/UES_Paqueteria/imprimir_etiqueta?id=9347338&numero=UES1696421783170&env=8732622&cli=9649&tamanoEtiqueta=g"
}

# 4. Obtener tracking (Estado de envío)

GET /api/shipping/:id

Se emplea para rastrear el envío y obtener su status.

REQUEST

id: Número de envío obtenido en "Generar envío". Va en el id de la url como ruta parametrizada. Campo obligatorio.

Todos estos campos van en el header:

provider: Nombre del OOLL (UES Postal). Campo obligatorio.
user: (Tipo de dato: string). Usuario. Campo obligatorio.
pass: (Tipo de dato: string). Password. Campo obligatorio.

provider: UES Postal
user: test
pass: test_ues_921
apiKey: 20470
apiSecret: t3st1ng3

RESPONSE

providerStatus: Estado del envío.
fecha: Fecha y hora de la última notificación.

{
    "response": "Success",
    "providerStatus": "CREADO EN SISTEMA UES - SIN ACTIVIDAD",
    "numeroDeEnvio": "UES1696421783170",
    "fecha": "04/10/2023 09:16 AM",
    "sucursalDeDistribucion": {
        "id": null,
        "descripcion": null
    },
    "sucursalDeRendicion": null,
    "sucursalDeImposicion": null,
    "numeroDePermisionaria": null,
    "descripcionServicio": ""
}