1. Crear pieza
2. Consulta de historial de seguimiento
3. Consulta de estado actual
4. Ingresar acción a una pieza

Definición de pieza

Se conoce como pieza a un envío que puede contener una tarjeta, DNI, entradas a eventos, sobres con acuse, etc. Al crear una pieza, se envía la información de destinatario, operativa, domicilio, entre otros y se crea el lógico de esta.

Tipos de pieza

• Normal: Pieza individual común.
• Paquete: Pieza que entre 1 y 22 componentes o insumos. Por ejemplo, se puede utilizar para el envío de múltiples tarjetas. El paquete se envía al titular y, por lo tanto, el seguimiento se realiza sobre el mismo. Los componentes pueden ser extensiones de tarjeta dirigidos a personas autorizadas por el titular.
• Componente: Es una pieza individual que va dentro de un paquete y se debe vincular al mismo.

Para obtener las credenciales y acceder a los endpoints del controlador, debes ponerte en contacto con nuestra área de sistemas. Se pueden solicitar en la siguiente casilla de correo: integraciones@oca.com.ar

El proceso de inicio de sesión debe llevarse a cabo utilizando el endpoint loginSigma, del controlador Login. El token obtenido de la request tendrá una duración de 5 minutos, tras lo cual deberá hacer otra request al endpoint para obtener uno nuevo.

Permisos de usuario

Es importante tener en cuenta que, dependiendo del permiso del usuario, se habilitarán ciertos endpoints.

Los privilegios pueden ser: administrador, consulta o acciones. Según los permisos del usuario, se habilitarán los siguientes endpoints:

• Admin: Todos
• Consulta:
• GetAcuseByNumeroPieza
• GetAcuseByIdPieza
• GetAcusesByNumeroPieza
• PiezasPorDocumento
• EstadoActual
• HistorialSeguimiento
• HealthCheck
• Acciones:
• CrearPieza
• IngresarAccionV2
• Endpoints con acceso no restringido:
• ObtenerSucursalOca

Consideraciones de configuración previa de los usuarios

Internamente, los usuarios deben tener ciertos perfiles y productos asociados. Esto afectará los resultados que se muestren en los endpoints de consulta. Es necesario especificar para qué productos se va a utilizar la API, de forma que se creen perfiles y estos sean asociados.

Método

POST

URL de test

https://test.oca.com.ar/ApiPostal/LoginController/loginSigma

URL Productiva

https://www1.oca.com.ar/ApiPostal/LoginController/loginSigma

Ejemplo de response

    { 
      "success": true,
      "message": "Success",
      "result": "TU-TOKEN
    }

Descripción

El método obtenerSucursalOca nos permite obtener un array con información sobre aquellas sucursales que se encuentran habilitadas y poseen servicio de entrega de tarjetas en mostrador. Los parámetros son filtros de búsqueda, si se realiza una request sin especificarlos, el endpoint devolverá todas las sucursales disponibles.

Cada objeto del array representa una sucursal con los siguientes datos: Sigla de la sucursal, descripción (Nombre de la sucursal), domicilio completo, código postal, provincia, localidad, teléfono, horario de atención, latitud y longitud.

Los horarios de atención mostrarán solo los días en los que la sucursal se encuentre operativa. Si la sucursal abre los sábados, será especificado.

Devuelve un array vacío si no encuentra sucursales.

Algunas recomendaciones para tener en cuenta:

• No es necesario iniciar sesión para utilizar el endpoint.
• Los parámetros realizan una búsqueda exacta. Por ejemplo: Si en “Localidad” se ingresa “Lomas”, no se obtendrán resultados. Si se ingresa “Lomas de Zamora”, se obtendrán.
• Ambos parámetros no distinguen mayúsculas de minúsculas.
• Evitar utilizar tildes y caracteres especiales.

Método

GET

URL de test

https://test.oca.com.ar/ApiPostal/OCAGEOApiController/ObtenerSucursalOca

URL Productiva

https://www1.oca.com.ar/ApiPostal/OCAGEOApiController/ObtenerSucursalOca

Params

• Localidad:
• Descripción: Localidad donde se encuentra la sucursal. Si la provincia es “CAPITAL FEDERAL”, el campo localidad puede ser éste mismo valor o un barrio.
• Tipo: STRING
• Opcional: Si
• Ejemplo: "PILAR”
• Provincia:
• Descripción: Provincia donde se encuentra la sucursal.
• Tipo: STRING
• Opcional: Si
• Ejemplo: "BUENOS AIRES”

Ejemplo de request

curl -X 'GET' \ 'https://test.oca.com.ar/ApiPostal/OCAGEOApiController/ObtenerSucursalOca?Locali dad=lomas%20de%20zamora&Provincia=BUENOS%20AIRES' \ -H 'accept: */*' \ -H 'Authorization: bearer TU-TOKEN '

Ejemplo de response

    [{
      "sigla": "LZM",
      "descripcion": "SUCURSAL OCA: LOMAS DE ZAMORA",
      "domicilio": "Hipólito Irigoyen 8562",
      "codigoPostal": "1832",
      "provincia": "BUENOS AIRES",
      "localidad": "LOMAS DE ZAMORA",
      "telefono": "",
      "hsAtencion": "Lun a Vie: 08:30 a 18:00 Hs",
      "latitud": "-34.7551876",
      "longitud": "-58.401295"
    }]
    

Descripción

El método crearPieza se utiliza para poder dar de alta una pieza en forma lógica. Devuelve un Identificador único de la pieza creada, que puede ser utilizado en los métodos de consulta de esta API.

Existen 3 tipos de piezas que pueden ser creadas, dependiendo de la misma se requieren distintos parámetros.

Método

POST

URL de test

https://test.oca.com.ar/ApiPostal/OCAGEOApiController/CrearPieza

URL Productiva

https://www1.oca.com.ar/ApiPostal/OCAGEOApiController/CrearPieza

Request Body

• Retrocompatibilidad:
• Descripción: Mediante este parámetro elegimos el formato de la response. En caso de encontrarse vacío, se devolverá un Bad Request 400. True devuelve un formato de JSON de una versión anterior de la API (Status, Codigo, Texto, Pieza). Por otra parte, false devolverá un JSON con success, message y result.
• Tipo: BOOLEAN
• Opcional: No
• Ejemplo: false
• TipoPieza:
• Descripción: Tipo de pieza a crear. Según el tipoPieza especificado, algunos parámetros del request body se vuelven obligatorios. Valores posibles:
• 1 - Pieza individual,
• 3 - Paquete de producto,
• 4 - Componente de paquete.
• Tipo: STRING
• Opcional: Si
• Ejemplo: "BUENOS AIRES”
• NumeroPieza:
• Descripción: Identificador de la pieza determinado por el cliente.
• Tipo: String
• Opcional: No
• Longitud máxima: 30
• Ejemplo: “432123564532”
• Producto:
• Descripción: Nombre del producto. Este debe ser previamente acordado con OCA ya que los productos son configurados dentro de una operativa.
• Tipo: String
• Opcional: No
• Longitud máxima: 10
• Ejemplo: “VISAN”
• SucursalCliente:
• Descripción: Código de sucursal del cliente. Sirve para identificar el origen de la pieza y la sucursal de rendición en caso de ser necesario. Si se ingresa una sucursal inexistente, se creará la pieza asignándola a la casa central.
• Tipo: String
• Opcional: No
• Longitud máxima: 10
• Ejemplo: “0000000001”
• SucursalOCA:
• Descripción: Sigla de sucursal OCA para destino de la pieza. Utilizar únicamente si la entrega de la pieza es por mostrador. En caso de utilizarlo y no tener claro el código postal de la sucursal, establecer el campo codigoPostal en 0.
• Tipo: String
• Opcional: Si
• Longitud máxima: 5
• Ejemplo: “MRO”
• TipoDocumento:
• Descripción: Tipo de documento del destinatario (DNI, CUIT, CUIL, DU, PAS, LE).
• Tipo: String
• Opcional: Si
• Longitud máxima: 5
• Ejemplo: “DNI”
• NumeroDocumento:
• Descripción: Número de documento del destinatario.
• Tipo: String
• Opcional: Si
• Longitud máxima: 20
• Ejemplo: “39899788”
• Apellido:
• Descripción: Apellido del destinatario.
• Tipo: String
• Opcional: No
• Longitud máxima: 50
• Ejemplo: “Lopez”
• Nombre:
• Descripción: Nombre del destinatario.
• Tipo: String
• Opcional: No
• Longitud máxima: 60
• Ejemplo: “Pablo”
• Sexo:
• Descripción: Sexo del Destinatario. Los valores posibles son M, F, o X. Si no lo incluye, por defecto será M.
• Tipo: String
• Opcional: Si
• Longitud máxima: 2
• Ejemplo: “F”
• Observaciones:
• Descripción: Cualquier aclaración necesaria sobre el envío de la pieza.
• Tipo: String
• Opcional: Si
• Longitud máxima: 200
• Ejemplo: “Entregar al portero.”
• Calle:
• Descripción: Calle del domicilio del destinatario
• Tipo: String
• Opcional: No
• Longitud máxima: 50
• Ejemplo: “Av. Entre Ríos”
• Numero:
• Descripción: Número del domicilio del destinatario.
• Tipo: String
• Opcional: Si
• Longitud máxima: 10
• Ejemplo: “3601”
• Piso:
• Descripción: Piso del domicilio del destinatario.
• Tipo: String
• Opcional: Si
• Longitud máxima: 3
• Ejemplo: “5”
• Departamento:
• Descripción: Departamento del domicilio del destinatario.
• Tipo: String
• Opcional: Si
• Longitud máxima: 4
• Ejemplo: “C”
• Torre:
• Descripción: Torre del domicilio del destinatario.
• Tipo: String
• Opcional: Si
• Longitud máxima: 2
• Ejemplo: “A”
• Entrecalles:
• Descripción: Las entre calles del domicilio del destinatario.
• Tipo: String
• Opcional: Si
• Longitud máxima: 100
• Ejemplo: “Av. Callao y Talcahuano”
• CodigoPostal:
• Descripción: Código postal numérico del domicilio del destinatario. Si se definió una sucursal oca para entrega por mostrador, ingresar el código postal de la misma o utilizar el valor “0”. No dejar el campo vacío.
• Tipo: String
• Opcional: Si
• Longitud máxima: 8
• Ejemplo: “1213”
• Localidad:
• Descripción: Localidad del domicilio del destinatario.
• Tipo: String
• Opcional: No
• Longitud máxima: 40
• Ejemplo: “Cordoba capital”
• Provincia:
• Descripción: Provincia del domicilio del destinatario.
• Tipo: String
• Opcional: No
• Longitud máxima: 30
• Ejemplo: “Buenos Aires”
• Telefono::
• Descripción: Teléfono del destinatario.
• Tipo: String
• Opcional: Si
• Longitud máxima: 30
• Ejemplo: “4663968”
• TelefonoLaboral:
• Descripción: Teléfono laboral del destinatario.
• Tipo: String
• Opcional: Si
• Longitud máxima: 30
• Ejemplo: “0800 4332849”
• TelefonoCelular:
• Descripción: Teléfono celular del destinatario.
• Tipo: String
• Opcional: Si
• Longitud máxima: 30
• Ejemplo: “1122948767”
• Email:
• Descripción: Email del destinatario
• Tipo: String
• Opcional: Si
• Longitud máxima: 80
• Ejemplo: “usuario.ejemplo@gmail.com”
• FechaVisita:
• Descripción: Fecha en la cual se pacta con OCA la entrega de la pieza al destinatario.
• Tipo: String
• Opcional: Si
• Longitud máxima: 10
• Ejemplo: “10/12/2024”
• CodigoRangoHorario:
• Descripción: Código mediante el cual indicamos el rango horario de la visita al Destinatario. Valores Posibles:
• 1 = 8:30 - 18:00hs
• 2 = 8:30 - 13:00hs
• 3 = 13:00 - 18:00hs
• Tipo: String
• Opcional: No
• Longitud máxima: 1
• Ejemplo: “2”
• CodigoAccionAutomatica:
• Descripción: Código mediante el cual indicamos la ejecución de una acción de forma automática. Valores Posibles: 19, 17, 32, 36. (Ver apartado de acciones)
• Tipo: String
• Opcional: Si
• Longitud máxima: 4
• Ejemplo: “17”
• VinculoConPaquete:
• Descripción: Se utiliza cuando la pieza es un Componente de paquete (tipo 4). La misma recibe un valor a definir para generar su vinculación hacia el paquete correspondiente. Posteriormente al crearse un Paquete de Producto (tipo 3) se recibirá el mismo valor en el atributo vinculoComponente, produciéndose así la vinculación. No se requiere cuando la pieza es normal (tipo 1) o paquete (tipo 3).
• Tipo: String
• Opcional: Si
• Longitud máxima: 30
• Ejemplo: “C11411241”
• ClavePiezaCliente:
• Descripción: Clave o Código de Unicidad utilizado para identificar las piezas y evitar su repeticion del numeroPieza en el sistema
• Tipo: String
• Opcional: Si
• Longitud máxima: 50
• Ejemplo: “cxyqmt154367”
• AtributosCliente:
• Descripción: Array de objetos que puede ser utilizado para informar algún dato adicional con un fin específico dentro del circuito del sistema en caso de que el cliente lo requiera, por ejemplo: Limite de Compras, Nro. de Cuenta, datos a utilizar para imprimir contratos o formularios, etc. Según el atributo puede haber validaciones adicionales.
• Tipo: Array<Object>
• Opcional: Si
• Ejemplo:

[{
  "atributo": "NroEmbozado",
  "valor": "01123041"
}]
                        

• Atributo:
• Descripción: Nombre del atributo adicional.
• Tipo: String
• Opcional: Si
• Longitud máxima: 100
• Ejemplo: “lugarRetiro”
• Valor:
• Descripción: Valos del atributo adicional.
• Tipo: String
• Opcional: Si
• Longitud máxima: 100
• Ejemplo: “0112374F”
• Componentes:
• Descripción: Se utiliza cuando la pieza es Paquete de Producto (tipo 3) para informar los diferentes componentes que van a conformar al mismo. Recibe una lista de objetos donde cada uno representa un componente. (La vinculación ocurre mediante el atributo vinculoComponente).
• Tipo: Array<Object>
• Opcional: Si
• Longitud máxima: 22
• Ejemplo

[
  {
    "productoComponente": "100575",
    "vinculoComponente": "123456"
  },
  {
    "productoComponente": "100574",
    "vinculoComponente": "987654"
  }
]
                        

• Componente:
• Descripción: Objeto que se envía dentro del array de componentes al crear una pieza tipo paquete. Cada objeto representa un componente. Un paquete puede contener hasta 22 componentes.
• Tipo: Object
• Opcional: Si
• Ejemplo:

{
  "productoComponente": "100575",
  "vinculoComponente": "123456"
}
                        

• ProductoComponente:
• Descripción: Código del producto del componente. Debe ser un producto existente.
• Tipo: String
• Opcional: Si
• Longitud máxima: 20
• Ejemplo: “VISAN”
• VinculoComponente:
• Descripción: Código que vincula el paquete y el componente. Al crear el componente, este mismo valor irá en el parámetro “vinculoConPaquete”.
• Tipo: String
• Opcional: Si
• Longitud máxima: 30
• Ejemplo: “L01235592”

Ejemplo de request (Pieza tipo 3)

curl -X 'POST' \
'https://test.oca.com.ar/ApiPostal/OCAGEOApiController/CrearPieza' \
-H 'accept: */*' \
-H 'Authorization: bearer TU-TOKEN ' \
-H 'Content-Type: application/json' \
-d '{
  "retrocompatibilidad": true,
  "tipoPieza": "1",
  "numeroPieza": "3000890",
  "producto": "TVALSB",
  "sucursalCliente": "0000000000",
  "sucursalOCA": "LIR",
  "tipoDocumento": "DNI",
  "numeroDocumento": "45648798",
  "apellido": "Mastropiero",
  "nombre": "Rodrigo",
  "sexo": "M",
  "observaciones": "",
  "calle": "La Rioja",
  "numero": "301",
  "piso": "4",
  "departamento": "B",
  "torre": "",
  "entrecalles": "",
  "codigoPostal": "1214",
  "localidad": "CABA",
  "provincia": "",
  "telefono": "",
  "telefonoLaboral": "",
  "telefonoCelular": "1112467891",
  "email": "mail@email.com",
  "fechaVisita": "16/04/2021",
  "codigoRangoHorario": "1",
  "codigoAccionAutomatica": "17",
  "vinculoConPaquete": "",
  "clavePiezaCliente": ""
} '

Ejemplo de request (Pieza tipo 4)

curl -X 'POST' \
'https://test.oca.com.ar/ApiPostal/OCAGEOApiController/CrearPieza' \
-H 'accept: */*' \
-H 'Authorization: bearer TU-TOKEN ' \
-H 'Content-Type: application/json' \
-d '{
"retrocompatibilidad": true,
"tipoPieza": "4",
"numeroPieza": "3000890",
"producto": "TVALSB",
"sucursalCliente": "0000000000",
"sucursalOCA": "LIR",
"tipoDocumento": "DNI",
"numeroDocumento": "45648798",
"apellido": "Mastropiero",
"nombre": "Rodrigo",
"sexo": "M",
"observaciones": "",
"calle": "La Rioja",
"numero": "301",
"piso": "4",
"departamento": "B",
"torre": "",
"entrecalles": "",
"codigoPostal": "1214",
"localidad": "CABA",
"provincia": "",
"telefono": "",
"telefonoLaboral": "",
"telefonoCelular": "1112467891",
"email": "mail@email.com",
"fechaVisita": "16/04/2021",
"codigoRangoHorario": "1",
"codigoAccionAutomatica": "17",
"vinculoConPaquete": "9128765",
"clavePiezaCliente": ""
}
'

Ejemplo de response

• Retrocompatibilidad false

200 OK

{
  "success": true,
  "message": "Success",
  "result": "{\"IdentificadorPieza\":\"G0000251889514\",\"Status\":{\"Codigo\":1,\"Texto\":
  \"Ok\"}}"
}
    

• Retrocompatibilidad true

200 OK

{
  "identificadorPieza": "G0000251889513",
  "status": {
    "codigo": 1,
    "texto": "Ok"
  }
}
    

Response con errores generales

• producto inexistente.

200 OK

{
  "success": false,
  "message": "Error interno.: El atributo Codigo de Producto es Invalido",
  "result": ""
}

• SucursalCliente inexistente (se asigna a casa central)

200 OK

{
  "success": false,
  "message": "Error interno.: \"Atención! La SucursalCliente 0009090979 no existe, se asign
  ó la CasaCentral. Identificador pieza: G0000251889514\"",
  "result": ""
}

• sucursalOCA inexistente / deshabilitada

200 OK

{
  "success": false,
  "message": "Error interno.: La SucursalOCA no existe o no se encuentra habilitada.",
  "result": ""
}

• codigoPostal inválido

200 OK

{
  "success": false,
  "message": "Error interno.: El codigo postal no es correcto.",
  "result": ""
}  

• sexo inválido

200 OK

{
  "success": false,
  "message": "Error interno.: Sexo invalido, debe ingresar M, F o X.",
  "result": ""
} 

• codigoAccionAutomatica inválido

200 OK

{
  "success": false,
  "message": "Error interno.: El atributo Codigo de Accion Automatica es Invalida",
  "result": ""
}

• clavePiezaCliente existente para un número de pieza

200 OK

{
  "success": false,
  "message": "Error interno.: \"Pieza Nro. 3000890 existente para el Campo Clave 3543434 co
  n el identificador de OCA G0000251889446\"",
  "result": ""
}

• fechaVisita mayor a 15 días

200 OK

{
  "success": false,
  "message": "Error al validar el campo Fecha de Visita - La Fecha elegida debe estar dentr
  o de los 15 días a partir de Mañana",
  "result": ""
}

• idTipoPieza inexistente

400 Bad Request

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "traceId": "00-670244470c0cac6d68f7c6cdae06fa47-06e116b3cf2f4648-00",
  "errors": {
    "TipoPieza": [
      "Tipo Pieza invalido."
    ]
  }
}

• Código postal con letras

400 Bad Request

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "traceId": "00-f438f061ad67b9ebf61513e3294c7469-3e23f8c9e0ea6950-00",
  "errors": {
    "CodigoPostal": [
      "El campo solo acepta números."
    ]
  }
}

• codigoRangoHorario inválido

400 Bad Request

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "traceId": "00-eccd723ed09169ff0472579a91e1e63d-d64b31b536a3bc34-00",
  "errors": {
    "CodigoRangoHorario": [
      El campo solo puede contener los valores '1', '2' o '3'."
    ]
  }
}

Response con errores para paquetes

• Número máximo de componentes (22)

400 Bad Request

{
  "title": "One or more validation errors occurred.",
  "status": 400,
  "errors": {
    "Componente": [
      "La pieza de tipo 3 no puede tener mas de 22 componentes."
    ]
  }
}

• Producto que no es tipo paquete

200 OK

{
  "success": false,
  "message": "Error interno.: Error! El producto TVALSB no es del tipo paquete, no se puede
  crear la pieza",
  "result": ""
}

• productoComponente inexistente

200 OK

{
  "success": false,
  "message": "Error interno.: \"OkAdvertencia! Los productos ABC, de los componentes son in
  existentes \"",
  "result": ""
}

Descripción

El método piezasPorDocumento permite recuperar datos de la/s pieza/s asociadas al documento de un destinatario. Además de los datos del destinatario, se puede visualizar el último estado de la/s pieza/s.

Método

POST

URL de test

https://test.oca.com.ar/ApiPostal/OCAGEOApiController/PiezasPorDocumento

URL Productiva

https://www1.oca.com.ar/ApiPostal/OCAGEOApiController/PiezasPorDocumento

Request Body

• Retrocompatibilidad:
• Descripción: Mediante este parámetro elegimos el formato de la response. En caso de encontrarse vacío, se devolverá un Bad Request 400. True devuelve un formato de JSON de una versión anterior de la API (Status, Codigo, Texto, Pieza). Por otra parte, false devolverá un JSON con success, message y result.
• Tipo: BOOLEAN
• Opcional: No
• Ejemplo: false
• CantidadMeses:
• Descripción: Rango de meses previos a considerar en la búsqueda a partir del mes actual y retrocediendo. El número debe estar entre 1 y 6. Ejemplo: Ingresar 1 buscará piezas tanto del mes actual como del anterior.
• Tipo: INT
• Opcional: Si
• Ejemplo: 5
• estadosNoTerminal:
• Descripción: Si se establece en true, incluirá todos aquellos estados de piezas que no sean terminales (Piezas en distribución). Al indicar false, sólo se devolverán piezas en estados terminales (Finalizados)
• Tipo: BOOLEAN
• Opcional: No
• Ejemplo: true
• tipoDocumento:
• Descripción: Tipo de documento del destinatario.
• Tipo: String
• Opcional: Si
• Longitud máxima: 5
• Ejemplo: “DNI”
• numeroDocumento:
• Descripción: Número de documento del destinatario.
• Tipo: String
• Opcional: No
• Longitud máxima: 20
• Ejemplo: “39888999”
• producto:
• Descripción: Código de producto. Este valor es configurado previamente para el cliente desde OCA.
• Tipo: String
• Opcional: Si
• Longitud máxima: 10
• Ejemplo: “110229”, “VISAN”
• operativa:
• Descripción: Código de operativa. La misma es confeccionada por el Comercial y luego se habilita para el uso por parte del Cliente.
• Tipo: String
• Opcional: Si
• Longitud máxima: 10
• Ejemplo: “110229”

Ejemplo de request

curl -X 'POST' \
  'https://test.oca.com.ar/ApiPostal/OCAGEOApiController/PiezasPorDocumento' \
  -H 'accept: */*' \
  -H 'Authorization: bearer TU-TOKEN'\
  -H 'Content-Type: application/json' \
  -d '{
  "retrocompatibilidad": false,
  "cantidadMeses": 6,
  "estadosNoTerminal": true,
  "tipoDocumento": "",
  "numeroDocumento": "456487989",
  "producto": "",
  "operativa": ""
}'

Ejemplo de response

• Retrocompatibilidad false

200 OK

{
  "success": true,
  "message": "Success",
  "result": "[{\"NumeroPieza\":\"3000888000\",\"Destinatario\":\"Martinez Lautaro\",\"Opera
  tiva\":\"Diario Visa reemplaza op 100576\",\"IDPieza\":251889416,\"FechaInclusion\":\"08/11
  /2024 11:03:30\",\"IDTipoPieza\":1,\"IDPiezaTitular\":null,\"EstadoMotivoOCA\":\"Corrección
  Operativa/Sin Motivo\",\"FechaEstado\":\"08/11/2024 11:03:30\",\"Producto\":\"TVALSB-VISA A
  LTA\",\"CodigoEstadoCliente\":\"\",\"EstadoCliente\":\"\",\"IDEstadoPiezaOCA\":81,\"IDMotiv
  oPiezaOCA\":0,\"CodigoProducto\":\"TVALSB\",\"IdentificadorPiezaOCA\":\"G0000251889416\",\"
  Terminal\":false,\"CodigoEstadoWebOCA\":null,\"EstadoWebOCA\":\"NO INFORMAR\",\"CodigoEstad
  oMotivoUnificadoOCA\":null,\"DescripcionEstadoMotivoUnificado\":null,\"Domicilio\":\"La Rio
  ja 301 Torre: 4 B CP: 1214 CABA \",\"SucursalOCA\":\"\",\"SucursalCliente\":\"0000000000\"
  ,\"Descripcion_DomicilioSucOCA\":\"\",\"Descripcion_DomicilioSucCliente\":\"Casa Central -
  Florida 99 1er Piso CP: 1005 Capital Federal\"}]"
}
    

• Retrocompatibilidad true

200 OK

{
  "Status": {
  "Codigo": 1,
    "Texto": "Ok"
  },
  "Piezas": [
    {
    "numeroPieza": "3000888000",
    "destinatario": "Martinez Lautaro",
    "operativa": "Diario Visa reemplaza op 100576",
    "idPieza": 251889416,
    "fechaInclusion": "08/11/2024 11:03:30",
    "idTipoPieza": 1,
    "idPiezaTitular": null,
    "estadoMotivoOCA": "Corrección Operativa/Sin Motivo",
    "fechaEstado": "08/11/2024 11:03:30",
    "producto": "TVALSB-VISA ALTA",
    "codigoEstadoCliente": "",
    "estadoCliente": "",
    "idEstadoPiezaOCA": 81,
    "idMotivoPiezaOCA": 0,
    "codigoProducto": "TVALSB",
    "identificadorPiezaOCA": "G0000251889416",
    "terminal": false,
    "codigoEstadoWebOCA": null,
    "estadoWebOCA": "NO INFORMAR",
    "codigoEstadoMotivoUnificadoOCA": null,
    "descripcionEstadoMotivoUnificado": null,
    "domicilio": "La Rioja 301 Torre: 4 B CP: 1214 CABA ",
    "sucursalOCA": "",
    "sucursalCliente": "0000000000",
    "descripcion_DomicilioSucOCA": "",
    "descripcion_DomicilioSucCliente": "Casa Central - Florida 99 1er Piso CP: 1005 Capital Federal"
    }
  ]
}
    

• Response sin resultados

200 OK

{
  "success": false,
  "message": "No se encontraron piezas",
  "result": ""
}
    

Response con errores

• Cantidad de meses mayor a 6

400 Bad Request

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "traceId": "00-3b5f6c65849b5429400c8200b6a24cde-2a6f759ba34f3782-00",
  "errors": {
    "CantidadMeses": [
      "El rango de CantidadMeses es entre 1 y 6."
    ]
  }
}

Descripción

El método estadoActual nos permite recuperar el estado actual de una pieza, sea por el id de la pieza o por el identificador de la pieza. No obstante, se puede recuperar más de un estado actual por cada pieza que comparta el parámetro numeroPieza del cliente en caso de utilizarlo y que no sea único.

Es obligatorio enviar al menos uno de los tres parámetros mencionados.

Método

POST

URL de test

https://test.oca.com.ar/ApiPostal/OCAGEOApiController/EstadoActual

URL Productiva

https://www1.oca.com.ar/ApiPostal/OCAGEOApiController/EstadoActual

Request Body

• Retrocompatibilidad:
• Descripción: Mediante este parámetro elegimos el formato de la response. En caso de encontrarse vacío, se devolverá un Bad Request 400. True devuelve un formato de JSON de una versión anterior de la API (Status, Codigo, Texto, Pieza). Por otra parte, false devolverá un JSON con success, message y result.
• Tipo: BOOLEAN
• Opcional: No
• Ejemplo: false
• producto:
• Descripción: Código de producto. Este valor es configurado previamente para el cliente desde OCA. Si se proporciona el producto, debe proporcionarse el número de pieza.
• Tipo: STRING
• Opcional: Si
• Longitud máxima: 10
• Ejemplo: “117992”
• identificadorPieza
• Descripción: Número de seguimiento único de la pieza generado por OCA al dar de alta lógicamente la pieza.
• Tipo: STRING
• Opcional: Si
• Ejemplo: “G0000123456”
• idPieza:
• Descripción: Identificador único de la pieza en la base de datos. En caso de no enviarlo, establecer el parámetro en 0.
• Tipo: INT
• Opcional: Si
• Ejemplo: 12345
• numeroPieza:
• Descripción: Número de la pieza asignado por parte del cliente para su seguimiento.
• Tipo: STRING
• Opcional: Si
• Longitud máxima: 30
• Ejemplo: “12345”

Ejemplo de request

curl -X 'POST' \
  'https://test.oca.com.ar/ApiPostal/OCAGEOApiController/EstadoActual' \
  -H 'accept: */*' \
  -H 'Authorization: bearer TU-TOKEN'\
  -H 'Content-Type: application/json' \
  -d '{
  "retrocompatibilidad": false,
  "producto": "COOL",
  "numeroPieza": "99912343210",
  "identificadorPieza": "",
  "idpieza": 0
}'

Ejemplo de response

• Retrocompatibilidad false

200 OK

{
  "success": true,
  "message": "Success",
  "result": "[{\"NumeroPiezaCliente\":\"99912343210\",\"FechaEstado\":\"23/10/2024 16:22:50
  \",\"Operativa\":\"107665-Paquetes Clientes Cool\",\"Producto\":\"COOL-PAQUETES CLIENTES CO
  OL\",\"Recibo\":\"\",\"Carta\":\"\",\"FechaRendicion\":\"\",\"Cliente\":\"S1T - INDUSTRIAL
  AND COMERCIAL BANK OF CHINA\",\"Subservicio\":\"P7\",\"SucursalOCA\":\"\",\"SucursalCliente
  \":\"0000000000\",\"IdPieza\":251889394,\"Destinatario\":\"Maronna Jorge\",\"TipoPieza\":\"
  Paquete\",\"FechaInclusion\":\"\",\"FechaEnvioCliente\":\"\",\"PlanillaEnvio\":\"\",\"Fecha
  PlanillaEnvio\":\"\",\"EstadoMotivoOCA\":\"Corrección Operativa/Sin Motivo\",\"CodigoEstado
  Cliente\":\"0\",\"EstadoCliente\":\"\",\"IDEstadoPiezaOCA\":81,\"IDMotivoPiezaOCA\":0,\"Ide
  ntificadorPiezaOCA\":\"G0000251889394\",\"CodigoProducto\":\"COOL\",\"EstadoWebOCA\":\"NO I
  NFORMAR\",\"CodigoEstadoWebOCA\":null,\"CodigoEstadoMotivoUnificadoOCA\":null,\"Descripcion
  EstadoMotivoUnificado\":null,\"Domicilio\":\"La Rioja 301 Torre: 4 B CP: 1214 Once Caba\",
  \"Descripcion_DomicilioSucOCA\":null,\"Descripcion_DomicilioSucCliente\":\"Casa Central - F
  lorida 99 1er Piso CP: 1005 Capital Federal\"}]"
}
    

• Retrocompatibilidad true

200 OK

{
  "Status": {
  "Codigo": 1,
    "Texto": "Ok"
  },
  "Piezas": [
    {
      "numeroPiezaCliente": "99912343210",
      "fechaEstado": "23/10/2024 16:22:50",
      "operativa": "107665-Paquetes Clientes Cool",
      "producto": "COOL-PAQUETES CLIENTES COOL",
      "recibo": "",
      "carta": "",
      "fechaRendicion": "",
      "cliente": "S1T - INDUSTRIAL AND COMERCIAL BANK OF CHINA",
      "subservicio": "P7",
      "sucursalOCA": "",
      "sucursalCliente": "0000000000",
      "idPieza": 251889394,
      "destinatario": "Maronna Jorge",
      "tipoPieza": "Paquete",
      "fechaInclusion": "",
      "fechaEnvioCliente": "",
      "planillaEnvio": "",
      "fechaPlanillaEnvio": "",
      "estadoMotivoOCA": "Corrección Operativa/Sin Motivo",
      "codigoEstadoCliente": "0",
      "estadoCliente": "",
      "idEstadoPiezaOCA": 81,
      "idMotivoPiezaOCA": 0,
      "identificadorPiezaOCA": "G0000251889394",
      "codigoProducto": "COOL",
      "estadoWebOCA": "NO INFORMAR",
      "codigoEstadoWebOCA": null,
      "codigoEstadoMotivoUnificadoOCA": null,
      "descripcionEstadoMotivoUnificado": null,
      "domicilio": "La Rioja 301 Torre: 4 B CP: 1214 Once Caba",
      "descripcion_DomicilioSucOCA": null,
      "descripcion_DomicilioSucCliente": "Casa Central - Florida 99 1er Piso CP: 1005 Capital Federal"
    }
  ]
}
    

Response con errores generales

• Request sin idPieza, identificadorPieza o numeroPieza.

400 Bad Request

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "traceId": "00-7590cad52a36ae7ac52d8f71b00432f7-9545c90d7c1ba479-00",
  "errors": {
    "": [
    "Al menos uno de los campos debe ser proporcionado (Producto, NumeroPieza, Identifica
    dorPieza o Idpieza)."
    ]
  }
}

• Request con código de producto sin número de pieza

400 Bad Request

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "traceId": "00-f55ee0ab7bc2c401e25fe6b269f2e849-dd623d3c41ea45ff-00",
  "errors": {
    "Producto": [
    "Si se proporciona un producto, también debe proporcionarse un número de pieza."
    ]
  }
}

Descripción

El método historialSeguimiento nos permite recuperar el historial de seguimiento completo (Tracking) para una pieza determinada en orden cronológico, detallando cada estado, motivo y fecha de cambio.

Método

POST

URL de test

https://test.oca.com.ar/ApiPostal/OCAGEOApiController/HistorialSeguimiento

URL Productiva

https://www1.oca.com.ar/ApiPostal/OCAGEOApiController/HistorialSeguimiento

Request Body

• Retrocompatibilidad:
• Descripción: Mediante este parámetro elegimos el formato de la response. En caso de encontrarse vacío, se devolverá un Bad Request 400. True devuelve un formato de JSON de una versión anterior de la API (Status, Codigo, Texto, Pieza). Por otra parte, false devolverá un JSON con success, message y result.
• Tipo: BOOLEAN
• Opcional: No
• Ejemplo: false
• identificadorPieza
• Descripción: Número de seguimiento único de la pieza generado por OCA al dar de alta lógicamente la pieza.
• Tipo: STRING
• Opcional: Si
• Ejemplo: “G0000123456”
• idPieza:
• Descripción: Identificador único de la pieza en la base de datos. En caso de no enviarlo, establecer el parámetro en 0.
• Tipo: INT
• Opcional: Si
• Ejemplo: 12345
• numeroPieza:
• Descripción: Número de la pieza asignado por parte del cliente.
• Tipo: STRING
• Opcional: Si
• Longitud máxima: 30
• Ejemplo: “12345”

Ejemplo de request

curl -X 'POST' \
  'https://www1.oca.com.ar/ApiPostal/OCAGEOApiController/HistorialSeguimiento' \
  -H 'accept: */*' \
  -H 'Authorization: bearer TU-TOKEN ' \
  -H 'Content-Type: application/json' \
  -d '{
  "retrocompatibilidad": false,
  "identificadorPieza": "0",
  "idpieza": 251862470,
  "numeroPieza": "0"
}'

Ejemplo de response

• Retrocompatibilidad false

200 OK

{
  "success": true,
  "message": "Success",
  "result": "[{\"Historial\":[{\"FechaEstadoSolicitud\":\"07/06/2024 10:51:14\",\"EstadoDes
  cripcion\":\"A completar Paquete\",\"MotivoDescripcion\":\"Sin Motivo\",\"Usuario\":\"Test,
  user(TestUser)\",\"FechaEjecucion\":\"\",\"Respuesta\":\"\",\"Motivo\":\"\",\"Tipo\":\"ESTA
  DO\",\"IdEstadoPiezaOCA\":33,\"IdMotivoPiezaOCA\":0,\"CodigoEstadoWebOCA\":1,\"EstadoWebOCA
  \":\"En proceso de Retiro\",\"CodigoEstadoMotivoUnificadoOCA\":10,\"DescripcionEstadoMotivo
  Unificado\":\"Al Aguardo del Físico\"}],\"IdPieza\":251862470}]"
}
    

• Retrocompatibilidad true

200 OK

{
  "Status": {
    "Codigo": 1,
    "Texto": "Ok"
  },
  "Historiales": [
    {
      "historial": [
        {
          "fechaEstadoSolicitud": "07/06/2024 10:51:14",
          "estadoDescripcion": "A completar Paquete",
          "motivoDescripcion": "Sin Motivo",
          "usuario": Test, user(TestUser)",
          "fechaEjecucion": "",
          "respuesta": "",
          "motivo": "",
          "tipo": "ESTADO",
          "idEstadoPiezaOCA": 33,
          "idMotivoPiezaOCA": 0,
          "codigoEstadoWebOCA": 1,
          "estadoWebOCA": "En proceso de Retiro",
          "codigoEstadoMotivoUnificadoOCA": 10,
          "descripcionEstadoMotivoUnificado": "Al Aguardo del Físico"
        }
      ],
      "idPieza": 251862470
    }
  ]
}
    

Response con errores

• Los parámetros idPieza, identificadorPieza y numeroPieza no son obligatoriospor sí solos. Es obligatorio que al menos uno de los 3 parámetros sea enviado.

Descripción

El método ingresarAccionV2 ingresa una acción sobre una o varias piezas, modificando el circuito de distribución de la pieza si la misma se logra ejecutar exitosamente por parte de OCA.

Método

POST

URL de test

https://test.oca.com.ar/ApiPostal/OCAGEOApiController/IngresarAccionV2

URL Productiva

https://www1.oca.com.ar/ApiPostal/OCAGEOApiController/IngresarAccionV2

Request Body

• piezasAcciones:
• Descripción: Array de objetos piezaAccion. Representa una acción para una pieza. Debe haber al menos una acción. Se pueden enviar entre 1 y 100 acciones.
• Tipo: Array<Object>
• Opcional: No
• Longitud máxima: 100
• Ejemplo: [{ "producto": "100575", "numeroPieza": " PAQ113", "identificadorPieza": " G0000251803247", "idPieza": 251803247, "idAccion": 17, "filler": { "Observaciones": "Test filler ingresarAccionV2" } } ]
• cancelarAccionPrevia:
• Descripción: Anula la acción previa pendiente si la hubiera, ingresando una acción “cancelar” en cada pieza antes de la nueva acción. En caso de no cancelar la acción previa, es posible que algunas acciones no se ingresen debido a que la pieza posee una acción pendiente.
• Tipo: Boolean
• Opcional: No
• Ejemplo: true
• piezaAccion:
• Descripción: Objeto que indica la pieza y la acción que se ejecutará sobre la misma. Se encuentra dentro del array piezasAcciones
• Tipo: Object
• Opcional: No
• Ejemplo: { "producto": "100575", "numeroPieza": " PAQ113", "identificadorPieza": " G0000251803247", "idPieza": 251803247, "idAccion": 17, "filler": { "Observaciones": "Test filler ingresarAccionV2" } }
• producto:
• Descripción: Código de producto. Este valor es configurado previamente para el cliente desde OCA.
• Tipo: String
• Opcional: Si
• Longitud máxima: 100
• Ejemplo: “102110”
• numeroPieza:
• Descripción: Número de la pieza asignado por parte del cliente.
• Tipo: String
• Opcional: Si
• Longitud máxima: 100
• Ejemplo: “00012345431123”
• identificadorPieza:
• Descripción: Número de seguimiento de la pieza generado por OCA al dar de alta lógicamente la pieza.
• Tipo: String
• Opcional: Si
• Longitud máxima: 100
• Ejemplo: “G00001235421”
• idPieza:
• Descripción: Identificador único de la pieza en la base de datos. En caso de no enviarlo, establecer el parámetro en 0.
• Tipo: Int
• Opcional: Si
• Ejemplo: 54324512
• idAccion:
• Descripcion: Identificador único de la acción a realizar.
• Tipo: Int
• Opcional: No
• Ejemplo: 17
• filler:
• Descripción: Objeto que contiene parámetros adicionales requeridos según el idAccion. El filler debe corresponder al idAccion ingresado.
• Tipo: Object
• Opcional: No
• Ejemplo: { "Observaciones": "Test filler ingresarAccionV2" }

Ejemplo de request

curl -X 'POST' \
  'https://test.oca.com.ar/ApiPostal/OCAGEOApiController/IngresarAccionV2' \
  -H 'accept: */*' \
  -H 'Authorization: bearer TU-TOKEN \
  -H 'Content-Type: application/json' \
  -d '{
  "retrocompatibilidad": false,
  "piezasAcciones": [{
  "producto": "100575",
  "numeroPieza": " PAQ113",
  "identificadorPieza": " G0000251803247",
  "idPieza": 251803247,
  "idAccion": 17,
  "filler": {
  "Observaciones": "Test filler ingresarAccionV2"
  }
  }
  ],
  "cancelaAccionPrevia": true
} '

Ejemplo de response

• Retrocompatibilidad false

200 OK

{
  "success": true,
  "message": "Success",
  "result": "{\"Piezas\":[{\"Producto\":\"100575\",\"NumeroPieza\":\" PAQ113\",\"Identifica
  dorPieza\":\" G0000251803247\",\"IdPieza\":251803247,\"IdAccion\":17,\"StatusAccion\":{\"Co
  digo\":1,\"Texto\":\"OK\"}}],\"CantidadAccionesEnviadas\":1,\"CantidadAccionesRechazadas\":
  0,\"Status\":{\"Codigo\":1,\"Texto\":\"OK\"}}"
}
    

• Retrocompatibilidad true

200 OK

    {
      "piezas": [
        {
          "producto": "100575",
          "numeroPieza": " PAQ113",
          "identificadorPieza": " G0000251803247",
          "idPieza": 251803247,
          "idAccion": 17,
          "statusAccion": {
            "codigo": 1,
            "texto": "OK"
          }
        }
      ],
      "cantidadAccionesEnviadas": 1,
      "cantidadAccionesRechazadas": 0,
      "status": {
        "codigo": 1,
        "texto": "OK"
      }
    }
    

Response con errores generales

• Request sin numeroPieza, idPieza o identificadorPieza.

200 OK

{
  "success": false,
  "message": "Algunas acciones no pudieron ingresarse, revise en la lista de resultado.",
  "result": "{\"Piezas\":[{\"Producto\":\"\",\"NumeroPieza\":\"\",\"IdentificadorPieza\":\"
  \",\"IdPieza\":0,\"IdAccion\":17,\"StatusAccion\":{\"Codigo\":-1,\"Texto\":\"6 - Debe espec
  ificar un Numero de Pieza, Identificador de Pieza, o Idpieza a buscar\"}}],\"CantidadAccion
  esEnviadas\":1,\"CantidadAccionesRechazadas\":1,\"Status\":{\"Codigo\":-1,\"Texto\":\"Algun
  as acciones no pudieron ingresarse, revise en la lista de resultado.\"}}"
}

• Filler incorrecto

200 OK

{
  "success": false,
  "message": "Algunas acciones no pudieron ingresarse, revise en la lista de resultado.",
  "result": "{\"Piezas\":[{\"Producto\":\"\",\"NumeroPieza\":\"\",\"IdentificadorPieza\":\"
  \",\"IdPieza\":251803246,\"IdAccion\":42,\"StatusAccion\":{\"Codigo\":-1,\"Texto\":\"El fil
  ler no tiene la estructura correcta, el campo: observaciones es incorrecto.\"}}],\"Cantidad
  AccionesEnviadas\":1,\"CantidadAccionesRechazadas\":1,\"Status\":{\"Codigo\":-1,\"Texto\":\
  "Algunas acciones no pudieron ingresarse, revise en la lista de resultado.\"}}"
}

• Filler incompleto

200 OK

{
  "success": false,
  "message": "Algunas acciones no pudieron ingresarse, revise en la lista de resultado.
  ",
  "result": "{\"Piezas\":[{\"Producto\":\"\",\"NumeroPieza\":\"\",\"IdentificadorPieza\
  ":\"\",\"IdPieza\":251803246,\"IdAccion\":18,\"StatusAccion\":{\"Codigo\":-1,\"Texto\":
  \"El filler no tiene la estructura correcta, la cantidad de campos no coinciden para la
  acción 18. Controle.\"}}],\"CantidadAccionesEnviadas\":1,\"CantidadAccionesRechazadas\"
  :1,\"Status\":{\"Codigo\":-1,\"Texto\":\"Algunas acciones no pudieron ingresarse, revis
  e en la lista de resultado.\"}}"
}

• Acción no permitida para estado / motivo

200 OK

{
  "success": false,
  "message": "Algunas acciones no pudieron ingresarse, revise en la lista de resultado.",
  "result": "{\"Piezas\":[{\"Producto\":\"\",\"NumeroPieza\":\"\",\"IdentificadorPieza\":\"
  \",\"IdPieza\":251803246,\"IdAccion\":17,\"StatusAccion\":{\"Codigo\":-1,\"Texto\":\"22 - E
  rror no se puede ingresar la Accion en el estado actual de la pieza\"}}],\"CantidadAcciones
  Enviadas\":1,\"CantidadAccionesRechazadas\":1,\"Status\":{\"Codigo\":-1,\"Texto\":\"Algunas
  acciones no pudieron ingresarse, revise en la lista de resultado.\"}}"
}

• Pieza con acción pendiente

200 OK

{
  "success": false,
  "message": "Algunas acciones no pudieron ingresarse, revise en la lista de resultado.",
  "result": "{\"Piezas\":[{\"Producto\":\"\",\"NumeroPieza\":\"\",\"IdentificadorPieza\":\"
  \",\"IdPieza\":251803246,\"IdAccion\":17,\"StatusAccion\":{\"Codigo\":-1,\"Texto\":\"21 - L
  a pieza tiene una Accion pendiente, debe anularla si desea accionar\"}}],\"CantidadAcciones
  Enviadas\":1,\"CantidadAccionesRechazadas\":1,\"Status\":{\"Codigo\":-1,\"Texto\":\"Algunas
  acciones no pudieron ingresarse, revise en la lista de resultado.\"}}"
}

• IdAccion inexistente

200 OK

{
  "success": false,
  "message": "Algunas acciones no pudieron ingresarse, revise en la lista de resultado.",
  "result": "{\"Piezas\":[{\"Producto\":\"\",\"NumeroPieza\":\"\",\"IdentificadorPieza\":\"
  \",\"IdPieza\":251803246,\"IdAccion\":500,\"StatusAccion\":{\"Codigo\":-1,\"Texto\":\"16 -
  El codigo de Accion es inválido\"}}],\"CantidadAccionesEnviadas\":1,\"CantidadAccionesRecha
  zadas\":1,\"Status\":{\"Codigo\":-1,\"Texto\":\"Algunas acciones no pudieron ingresarse, re
  vise en la lista de resultado.\"}}"
}

• Producto inexistente

200 OK

{
  "success": false,
  "message": "Algunas acciones no pudieron ingresarse, revise en la lista de resultado.
  ",
  "result": "{\"Piezas\":[{\"Producto\":\"1VISA\",\"NumeroPieza\":\"\",\"IdentificadorP
  ieza\":\"\",\"IdPieza\":251803246,\"IdAccion\":19,\"StatusAccion\":{\"Codigo\":-1,\"Tex
  to\":\"7 - No existe el producto ingresado.\"}}],\"CantidadAccionesEnviadas\":1,\"Canti
  dadAccionesRechazadas\":1,\"Status\":{\"Codigo\":-1,\"Texto\":\"Algunas acciones no pud
  ieron ingresarse, revise en la lista de resultado.\"}}"
}

• IdPieza no existente

200 OK

{
  "success": false,
  "message": "Algunas acciones no pudieron ingresarse, revise en la lista de
  resultado.",
  "result":
  "{\"Piezas\":[{\"Producto\":\"\",\"NumeroPieza\":\"\",\"IdentificadorPieza\":\"\",\"IdPi
  eza\":1231234134,\"IdAccion\":19,\"StatusAccion\":{\"Codigo\":-1,\"Texto\":\"8 - El
  Numero de Idpieza es
  Inexistente\"}}],\"CantidadAccionesEnviadas\":1,\"CantidadAccionesRechazadas\":
  1,\"Status\":{\"Codigo\":-1,\"Texto\":\"Algunas acciones no pudieron ingresarse,
  revise en la lista de resultado.\"}}"
}

• Acción no permitida para el tipo de pieza

200 OK

{
  "success": false,
  "message": "Algunas acciones no pudieron ingresarse, revise en la lista de resultado.",
  "result": "{\"Piezas\":[{\"Producto\":\"TVALSB\",\"NumeroPieza\":\"\",\"IdentificadorPiez
  a\":\"\",\"IdPieza\":251889511,\"IdAccion\":18,\"StatusAccion\":{\"Codigo\":-1,\"Texto\":\"
  20 - La pieza a Accionar debe ser de tipo Titular o de tipo Paquete\"}}],\"CantidadAcciones
  Enviadas\":1,\"CantidadAccionesRechazadas\":1,\"Status\":{\"Codigo\":-1,\"Texto\":\"Algunas
  acciones no pudieron ingresarse, revise en la lista de resultado.\"}}"
}

• Request sin acciones

400 Bad Request

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "traceId": "00-6e9f27d6208fbeba4b0583d8bb69d551-55688ec134eafe26-00",
  "errors": {
    "PiezasAcciones": [
      "Debe enviar al menos una pieza para ejecutar la acción."
    ]
  }
}

• Request con más de 100 acciones

400 Bad Request

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "traceId": "00-112dfbf57affac607256854207533a8a-a26f3907f7d7934c-00",
  "errors": {
    "PiezasAcciones": [
      "No puede haber mas de 100 PiezaAccion."
    ]
  }
}

Los distintos tipos de acciones permitidas para las piezas dependen de los estados y motivos en los que éstas se encuentren. A su vez, cada acción requiere de un filler particular con parámetros específicos.

Tener en cuenta que algunas acciones también dependen del tipo de pieza sobre la que actúen.

Acción 12 - Llamada infructuosa

Descripción

Tipo de acción: Solo visualización.

Tipo de piezas a accionar: Normal, Paquete

Esta acción es utilizada por los call center para dejar registro de las llamadas no respondidas.

Parámetros

Acción con filler de ejemplo

{
  "retrocompatibilidad": false,
  "piezasAcciones": [
    {
    "producto": "100575",
    "numeroPieza": "",
    "identificadorPieza": "",
    "idPieza": 251803247,
    "idAccion": 12,
    "filler":
      {
        "observaciones": "observaciones de llamada"
      }
    }
  ],
  "cancelaAccionPrevia": true
} 
                  

Estados y motivos permitidos

Acción 17 - Rescatar a sucursal origen

Descripción

Tipo de acción: Actualización

Tipo de piezas a accionar: Normal, paquete

Esta acción se utiliza cuando un cliente quiere solicitar que la pieza salga de distribución a domicilio y se entregue en la sucursal del cliente que se haya informado en el lógico del alta de esa pieza.

Parámetros

Acción con filler de ejemplo

{
  "retrocompatibilidad": false,
  "piezasAcciones": [
    {
    "producto": "100575",
    "numeroPieza": "",
    "identificadorPieza": "",
    "idPieza": 251803247,
    "idAccion": 17,
    "filler":
      {
        "observaciones": "El timbre no funciona."
      }
    }
  ],
  "cancelaAccionPrevia": true
}
                  

Estados y motivos permitidos

Acción 18 - Rescatar

Descripción

Tipo de acción: Actualización

Tipo de piezas a accionar: Normal, paquete

Esta acción se utiliza cuando un cliente quiere solicitar que la pieza salga de distribución a domicilio y se entregue en la sucursal del cliente que se haya especificado en el parámetro “sucursalCliente”.

Parámetros

Acción con filler de ejemplo

{
  "retrocompatibilidad": false,
  "piezasAcciones": [
    {
      "producto": "100575",
      "numeroPieza": "",
      "identificadorPieza": "",
      "idPieza": 251803247,
      "idAccion": 18,
      "filler":
        {
          "SucursalCliente": "0000000008",
          "Observaciones": "Devolver a la brevedad"
        }
    }
  ],
  "cancelaAccionPrevia": true
}
                  

Response con errores

• Sucursal de cliente inexistente.

200 OK

{
  "success": false,
  "message": "Algunas acciones no pudieron ingresarse, revise en la lista de resultado.",
  "result": "{\"Piezas\":[{\"Producto\":\"100575\",\"NumeroPieza\":\"\",\"IdentificadorPiez
  a\":\"\",\"IdPieza\":251803247,\"IdAccion\":18,\"StatusAccion\":{\"Codigo\":-1,\"Texto\":\"
  Error al validar el campo Sucursal Cliente\"}}],\"CantidadAccionesEnviadas\":1,\"CantidadAc
  cionesRechazadas\":1,\"Status\":{\"Codigo\":-1,\"Texto\":\"Algunas acciones no pudieron ing
  resarse, revise en la lista de resultado.\"}}"
}

Estados y motivos permitidos

Acción 19 - Rescatar a casa central

Descripción

Tipo de acción: Actualización

Tipo de piezas a accionar: Normal, paquete

Esta acción se utiliza cuando un cliente quiere solicitar que la pieza salga de distribución a domicilio y se entregue en la Casa Central del cliente.

Parámetros

Acción con filler de ejemplo

{
  "retrocompatibilidad": false,
  "piezasAcciones": [
    {
      "producto": "100575",
      "numeroPieza": "",
      "identificadorPieza": "",
      "idPieza": 251803247,
      "idAccion": 19,
      "filler":
        {
          "Observaciones": "Devolver a la brevedad"
        }
    }
  ],
  "cancelaAccionPrevia": true
}
                  

Estados y motivos permitidos

Acción 21 - Cambiar sucursal cliente

Descripción

Tipo de acción: Actualización

Tipo de piezas a accionar: Normal, paquete

Esta acción se utiliza para modificar forzosamente el cambio de una sucursal del cliente informada en el lógico de la pieza.

Parámetros

Acción con filler de ejemplo

{
  "retrocompatibilidad": false,
  "piezasAcciones": [
    {
      "producto": "100575",
      "numeroPieza": "",
      "identificadorPieza": "",
      "idPieza": 251803247,
      "idAccion": 21,
      "filler":
        {
          "sucursalCliente": "00000000"
        }
    }
  ],
  "cancelaAccionPrevia": true
}
                  

Response con errores

• sucursalCliente inexistente

Estados y motivos permitidos

Acción 22 - Rescate a Sucursal con Domicilio

Descripción

Tipo de acción: Actualización

Tipo de piezas a accionar: Normal, paquete

Esta acción se utiliza para un cliente quiere solicitar que la pieza salga de distribución a domicilio y se entregue en la sucursal del cliente que se haya informado en el lógico del alta de esa pieza. A diferencia de la acción 17 que tiene esta misma función, se debe indicar un domicilio nuevo.

Se compara internamente si la sucursal de banco existe, en caso afirmativo se actualizará el domicilio de esta. Si no existe, se creará.

Parámetros

Acción con filler de ejemplo

{
  "retrocompatibilidad": false,
  "piezasAcciones": [
    {
    "producto": "100575",
    "numeroPieza": "",
    "identificadorPieza": "",
    "idPieza": 251803247,
    "idAccion": 22,
    "filler": {
      "codigoBanco": "000",
      "sucursalBanco": "0000001",
      "descripcionBanco": "Banco Galicia",
      "descripcionSucursalBanco": "Sucursal Cabildo",
      "domicilioEntrega": "Av Cabildo 1230",
      "localidad": "Capital Federal",
      "codigoPostal": "1426",
      "Contacto": "Portería"
      }
    }],
  "cancelaAccionPrevia": true
}
                  

Estados y motivos permitidos

Acción 23 - Entregada por sucursal del Banco

Descripción

Tipo de acción: Solo visualización.

Tipo de piezas a accionar: Normal, paquete

Esta acción permite indicarle al cliente que la pieza se entregó por parte de la sucursal de este cuando la misma ha finalizado su circuito por parte de OCA. El estado de la pieza no es modificado, sino que queda “marcada” a modo de estado interno para el cliente.

Parámetros

Sin parámetros adicionales. Enviar objeto vacío.

Acción con filler de ejemplo

{
  "retrocompatibilidad": false,
  "piezasAcciones": [
    {
      "producto": "100575",
      "numeroPieza": "",
      "identificadorPieza": "",
      "idPieza": 251803247,
      "idAccion": 23,
      "filler":
        {}
    }
  ],
  "cancelaAccionPrevia": true
}
                  

Estados y motivos permitidos

Acción 24 - Modificación de datos destinatarios

Descripción

Tipo de acción: Actualización

Tipo de piezas a accionar: Normal, paquete

Esta ación se utiliza cuando se requiere forzar el cambio de los datos del destinatario de una pieza lógica.

Parámetros

Acción con filler de ejemplo

{
  "retrocompatibilidad": false,
  "piezasAcciones": [
    {
    "producto": "100575",
    "numeroPieza": "",
    "identificadorPieza": "",
    "idPieza": 251803247,
    "idAccion": 24,
    "filler": {
      "nombre": "María",
      "apellido": "Sanchez",
      "tipoDocumento": "CUIL",
      "numeroDocumento": "20389876549",
      "telefono": "",
      "celular": "1122334455",
      "mail": "sanchez.m@gmail.com"
      }
    }],
  "cancelaAccionPrevia": true
}
                  

Estados y motivos permitidos

Acción 28 - Recibida por sucursal del Banco

Descripción

Tipo de acción: Solo visualización.

Tipo de piezas a accionar: Normal, paquete

Esta acción permite indicarle al cliente que la pieza se recibió en la sucursal de este cuando la misma ha finalizado su circuito por parte de OCA. El estado de la pieza no es modificado, sino que queda “marcada” a modo de estado interno para el cliente

Parámetros

Sin parámetros adicionales. Enviar objeto vacío.

Acción con filler de ejemplo

{
  "retrocompatibilidad": false,
  "piezasAcciones": [
    {
      "producto": "100575",
      "numeroPieza": "",
      "identificadorPieza": "",
      "idPieza": 251803247,
      "idAccion": 28,
      "filler":
      {}
    }
  ],
  "cancelaAccionPrevia": true
}
                  

Estados y motivos permitidos

Acción 29 - Destruida por sucursal del Banco

Descripción

Tipo de acción: Solo visualización.

Tipo de piezas a accionar: Normal, paquete

Esta acción permite indicarle al cliente que la pieza se destruyó en la sucursal de este cuando la misma ha finalizado su circuito por parte de OCA. El estado de la pieza no es modificado, sino que queda “marcada” a modo de estado interno para el cliente

Parámetros

Sin parámetros adicionales. Enviar objeto vacío.

Acción con filler de ejemplo

{
  "retrocompatibilidad": false,
  "piezasAcciones": [
    {
      "producto": "100575",
      "numeroPieza": "",
      "identificadorPieza": "",
      "idPieza": 251803247,
      "idAccion": 29,
      "filler":
      {}
    }
  ],
  "cancelaAccionPrevia": true
}
                  

Estados y motivos permitidos

Acción 32 - Destruir físico

Descripción

Tipo de acción: Solo visualización.

Tipo de piezas a accionar: Normal, paquete

Esta acción se utiliza cuando un cliente quiere realizar el proceso de destrucción del físico de una pieza.

Parámetros

Acción con filler de ejemplo

{
  "retrocompatibilidad": false,
  "piezasAcciones": [
    {
    "producto": "100575",
    "numeroPieza": "",
    "identificadorPieza": "",
    "idPieza": 251803247,
    "idAccion": 32,
    "filler":
      {
        "observaciones": "No retira."
      }
    }
  ],
  "cancelaAccionPrevia": true
}
                  

Estados y motivos permitidos

Acción 33 - Agregar vínculo a paquete

Descripción

Tipo de acción: Actualización.

Tipo de piezas a accionar: Paquete

Esta acción se utiliza para vincular un nuevo componente a un paquete en proceso de imposición que no esté cerrado.

Parámetros

Acción con filler de ejemplo

{
  "retrocompatibilidad": false,
  "piezasAcciones": [
    {
      "producto": "100575",
      "numeroPieza": "",
      "identificadorPieza": "",
      "idPieza": 251803247,
      "idAccion": 33,
      "filler": {
        "productoComponente": "PRODTEST",
        "vinculoComponente": "00001C"
      }
    }
  ],
  "cancelaAccionPrevia": true
}
                  

Estados y motivos permitidos

Acción 34 - Modificar vínculo

Descripción

Tipo de acción: Actualización.

Tipo de piezas a accionar: Paquete

Esta acción se utiliza para modificar cualquier vínculo de componente de un paquete en proceso de imposición que no esté cerrado.

Parámetros

Acción con filler de ejemplo

{
  "retrocompatibilidad": false,
  "piezasAcciones": [
    {
      "producto": "100575",
      "numeroPieza": "",
      "identificadorPieza": "",
      "idPieza": 251803247,
      "idAccion": 34,
      "filler": {
        "productoComponente": "PRODTEST",
        "vinculoComponente": "00001C",
        "nuevoVinculoComponente": "00002"
      }
    }
  ],
  "cancelaAccionPrevia": true
}
                  

Estados y motivos permitidos

Acción 35 - Eliminar vínculo

Descripción

Tipo de acción: Actualización.

Tipo de piezas a accionar: Paquete

Esta acción se utiliza para eliminar cualquier vínculo de componente de un paquete en proceso de imposición que no esté cerrado. El componente seguirá existiendo sin vincular a ningún paquete.

Parámetros

Acción con filler de ejemplo

{
  "retrocompatibilidad": false,
  "piezasAcciones": [
    {
      "producto": "100575",
      "numeroPieza": "",
      "identificadorPieza": "",
      "idPieza": 251803247,
      "idAccion": 35,
      "filler": {
        "productoComponente": "PRODTEST",
        "vinculoComponente": "00001C"
      }
    }
  ],
  "cancelaAccionPrevia": true
}
                  

Estados y motivos permitidos

Acción 36 - Retener

Descripción

Tipo de acción: Actualización.

Tipo de piezas a accionar: Normal, paquete

Esta acción se utiliza para retener una pieza y detener su circuito. Generalmente se realiza durante el proceso de armado de las piezas. Una vez retenida, sólo se puede reactivar por otra acción del cliente, tal como un reenvío (repacto).

Parámetros

Acción con filler de ejemplo

{
  "retrocompatibilidad": false,
  "piezasAcciones": [
    {
      "producto": "100575",
      "numeroPieza": "",
      "identificadorPieza": "",
      "idPieza": 251803247,
      "idAccion": 36,
      "filler":
      {
        "observaciones": ""
      }
    }
  ],
  "cancelaAccionPrevia": true
}
                  

Estados y motivos permitidos

Acción 38 - Eliminar componente

Descripción

Tipo de acción: Actualización.

Tipo de piezas a accionar: Paquete

Esta acción se utiliza para eliminar un componente de una pieza tipo paquete

Parámetros

Acción con filler de ejemplo

{
  "retrocompatibilidad": false,
  "piezasAcciones": [
    {
      "producto": "100575",
      "numeroPieza": "",
      "identificadorPieza": "",
      "idPieza": 251803247,
      "idAccion": 38,
      "filler": {
        "productoComponente": "PRODTEST",
        "vinculoComponente": "00001C"
      }
    }
  ],
  "cancelaAccionPrevia": true
}
                  

Estados y motivos permitidos

Acción 48 - Anular lógico

Descripción

Tipo de acción: Actualización.

Tipo de piezas a accionar: Normal, paquete

Se utiliza para anular el lógico enviado para una pieza. Esta debe tener el estado “Lógico recibido” para que la acción sea posible.

Parámetros

Sin parámetros adicionales. Enviar objeto vacío.

Acción con filler de ejemplo

{
  "retrocompatibilidad": false,
  "piezasAcciones": [
    {
      "producto": "100575",
      "numeroPieza": "",
      "identificadorPieza": "",
      "idPieza": 251803247,
      "idAccion": 48,
      "filler":
      {}
    }
  ],
  "cancelaAccionPrevia": true
}
                  

Estados y motivos permitidos

Acción 51 - Entrega en mostrador de sucursal OCA

Descripción

Tipo de acción: Actualización.

Tipo de piezas a accionar: Normal, paquete

La acción se utiliza para indicar que la pieza puede ser entregada por el mostrador de una sucursal de OCA.

Parámetros

Acción con filler de ejemplo

{
  "retrocompatibilidad": false,
  "piezasAcciones": [
    {
      "producto": "100575",
      "numeroPieza": "",
      "identificadorPieza": "",
      "idPieza": 251803247,
      "idAccion": 51,
      "filler":
      {
        "sucursalOca": "PIA",
        "personasAutorizadas": "Diego Lopez"
      }
    }
  ],
  "cancelaAccionPrevia": true
}
                  

Estados y motivos permitidos

Acción 54 - Reingreso a Stock Complemento

Descripción

Tipo de acción: Actualización.

Tipo de piezas a accionar: Normal

Se utiliza para casos donde las piezas físicas sean innominadas1 y no hayan sido entregadas. La acción permite forzar al físico a reingresarse al stock para poder ser reutilizado en otro envío.

1: Piezas físicas genéricas que pueden ser vinculadas a cualquier destinatario.

Parámetros

Acción con filler de ejemplo

{
  "retrocompatibilidad": false,
  "piezasAcciones": [
    {
    "producto": "100575",
    "numeroPieza": "",
    "identificadorPieza": "",
    "idPieza": 251803247,
    "idAccion": 54,
    "filler":
      {
        "observaciones": "Reingresar"
      }
    }
  ],
  "cancelaAccionPrevia": true
}
                  

Estados y motivos permitidos

Acción 91 - Reenviar

Descripción

Tipo de acción: Actualización.

Tipo de piezas a accionar: Normal, paquete

Esta acción se utiliza para pactar una visita a domicilio en una fecha y franja horaria específicas.

Parámetros

Acción con filler de ejemplo

{
  "retrocompatibilidad": false,
  "piezasAcciones": [
    {
      "producto": "100575",
      "numeroPieza": "",
      "identificadorPieza": "",
      "idPieza": 251803247,
      "idAccion": 91,
      "filler": {
        "lunes": "X",
        "martes": "",
        "miercoles": "X",
        "jueves": "",
        "viernes": "X",
        "sabado": "",
        "horaDesde": "10:00",
        "horaHasta": "16:00",
        "observaciones": "Casa con rejas grises",
        "FechaPactadaVisita": "04/12/2023",
        "semanaaVisitarComienza": ""
      }
    }
  ],
  "cancelaAccionPrevia": true
}
                  

Estados y motivos permitidos

Acción 92 - Repactar

Descripción

Tipo de acción: Actualización.

Tipo de piezas a accionar: Normal, paquete

Esta acción se utiliza para pactar una visita en una fecha y franja horaria específicas, informando un nuevo domicilio.

Parámetros

Acción con filler de ejemplo

{
  "retrocompatibilidad": false,
  "piezasAcciones": [
    {
      "producto": "100575",
      "numeroPieza": "",
      "identificadorPieza": "",
      "idPieza": 251803247,
      "idAccion": 92,
      "filler": {
      "calle": "Avenida Siempre Viva",
      "numero": "742",
      "Torre": "",
      "Piso": "4",
      "Departamento": "C",
      "Localidad": "EL DORADO",
      "Provincia": "MISIONES",
      "CodigoPostal": "8000",
      "Pais": "ARGENTINA",
      "Telefono": "3512545589",
      "Lunes": "X",
      "Martes": "X",
      "Miercoles": "X",
      "Jueves": "",
      "Viernes": "X",
      "Sabado": "",
      "HoraDesde": "10:00",
      "HoraHasta": "15:00",
      "Observaciones": "",
      "FechaPactadaVisita": "23/05/2022",
      "SemanaaVisitarComienza": ""
    }
  }],
  "cancelaAccionPrevia": true
}
                  

Validaciones

• Código postal inválido

{
  "piezas": [
    {
      "producto": "100575",
      "numeroPieza": "",
      "identificadorPieza": "",
      "idPieza": 251803247,
      "idAccion": 92,
      "statusAccion": {
        "codigo": -1,
        "texto": "Error al validar el campo Codigo Postal"
      }
    }
  ],
  "cantidadAccionesEnviadas": 1,
  "cantidadAccionesRechazadas": 1,
  "status": {
    "codigo": -1,
    "texto": "Algunas acciones no pudieron ingresarse, revise en la lista de resultado."
  }
}
                    

• Fecha de semana de visita inválida

{
  "piezas": [
  {
    "producto": "100575",
    "numeroPieza": "",
    "identificadorPieza": "",
    "idPieza": 251803247,
    "idAccion": 92,
    "statusAccion": {
      "codigo": -1,
      "texto": "Error al validar el campo Codigo Postal"
    }
  }
  ],
  "cantidadAccionesEnviadas": 1,
  "cantidadAccionesRechazadas": 1,
  "status": {
    "codigo": -1,
    "texto": "Algunas acciones no pudieron ingresarse, revise en la lista de resultado."
  }
}
                    

Estados y motivos permitidos

Acción 999 - Cancelar

Descripción

Tipo de acción:Cancelar.

Esta acción se utiliza para cancelar aquellas acciones que se encuentren pendientes de ejecución y ya no quieran ser enviadas.

Parámetros

Acción con filler de ejemplo

{
  "retrocompatibilidad": false,
  "piezasAcciones": [
    {
    "producto": "100575",
    "numeroPieza": "",
    "identificadorPieza": "",
    "idPieza": 251803247,
    "idAccion": 999,
    "filler":
      {
      "observaciones": ""
      }
    }
  ],
  "cancelaAccionPrevia": true
}
                  

Estados y motivos permitidos

Descripción

El método GetAcuseByNumeroPieza se usa para obtener el PDF del acuse asociado a una determinada pieza, vinculada a un determinado cliente.

Método

GET

URL de test

https://test.oca.com.ar/ApiPostal/OCAGEOApiController/GetAcuseByNumeroPieza

URL Productiva

https://www1.oca.com.ar/ApiPostal/OCAGEOApiController/GetAcuseByNumeroPieza

Params

• numeroPieza:
• Descripción: Número de la pieza asignado por parte del cliente.
• Tipo: String
• Opcional: No
• Ejemplo: F0123456
• devolverUrl:
• Descripción: Parámetro para determinar la forma en la que se obtiene el acuse. Si se ingresa false se obtiene un pdf en formato base64, true devuelve una url. Por default se obtiene la url.
• Tipo: Boolean
• Opcional: Si
• Ejemplo: false

Ejemplo de request

https://www1.oca.com.ar/ApiPostal/OCAGEOApiController/GetAcuseByNumeroPieza?numeroPieza=0000000163125611&devolverUrl=true

Ejemplo de response

200 OK

{
  "success": true,
  "message": "Success",
  "result":
  "https://www3.oca.com.ar/Digitalizacion/Imagen/ver?id=132498064&op=0&clase=ACUSES&rdp=&cli=BCD&fecha="
}
                  

Response con errores generales

• Pieza inexistente

200 OK

{
  "success": false,
  "message": "Error interno.: No se encontró la pieza: 12345",
  "result": ""
}
    

• Pieza sin acuse

200 OK

{
  "success": false,
  "message": "Error interno.: No existe el Acuse de la Pieza solicitada.",
  "result": ""
}
    

Descripción

El método GetAcuseByIdPieza se usa para obtener el PDF del acuse asociado a una determinada pieza, vinculada a un determinado cliente.

Método

GET

URL de test

https://test.oca.com.ar/ApiPostal/OCAGEOApiController/GetAcuseByIdPieza

URL Productiva

https://www1.oca.com.ar/ApiPostal/OCAGEOApiController/GetAcuseByIdPieza

Params

• idPieza:
• Descripción: Identificador único de la pieza en la base de datos.
• Tipo: String
• Opcional: No
• Ejemplo: F0123456
• devolverUrl:
• Descripción: Parámetro para determinar la forma en la que se obtiene el acuse. Si se ingresa false se obtiene un pdf en formato base64, true devuelve una url. Por default se obtiene la url.
• Tipo: Boolean
• Opcional: Si
• Ejemplo: false

Ejemplo de request

https://www1.oca.com.ar/ApiPostal/OCAGEOApiController/GetAcuseByIdPieza?iDPieza=132498064&devolverUrl=true

Ejemplo de response

200 OK

{
  "success": true,
  "message": "Success",
  "result":
  "https://www3.oca.com.ar/Digitalizacion/Imagen/ver?id=132498064&op=0&clase=ACUSES&rdp=&cli=BCD&fecha="
}
                  

Validaciones generales

• Pieza inexistente

200 OK

{
  "success": false,
  "message": "Error interno.: No se encontró la pieza: 12345",
  "result": ""
}
    

• Pieza sin acuse

200 OK

{
  "success": false,
  "message": "Error interno.: No existe el Acuse de la Pieza solicitada.",
  "result": ""
}
    

Descripción

El método GetAcusesByNumeroPieza se usa para obtener un array de acuses en PDF de múltiples piezas vinculadas a un determinado cliente.

Por cada elemento del array se proporcionará un estado. Como muestra el ejemplo, si se encuentra alguna de las piezas se devolverá la url o el base64 del acuse. De lo contrario, se devolverá el correspondiente mensaje de error.

Método

POST

URL de test

https://test.oca.com.ar/ApiPostal/OCAGEOApiController/GetAcusesByNumeroPieza

URL Productiva

https://www1.oca.com.ar/ApiPostal/OCAGEOApiController/GetAcusesByNumeroPieza

Params

• devolverUrl:
• Descripción: Parámetro para determinar la forma en la que se obtiene el acuse. Si se ingresa false se obtiene un pdf en formato base64, true devuelve una url. Por default se obtiene la url.
• Tipo: Boolean
• Opcional: Si
• Ejemplo: false

Request Body

• NumerosPiezas:
• Descripción: Array de strings que contiene los distintos números de pieza a consultar.
• Tipo: Array<Object>
• Opcional: No
• Ejemplo: [“12345”, “6789”]

Validaciones generales

• Array sin piezas

200 OK

{
  "success": false,
  "message": "Error interno.: Parametro en input numerosPiezas null!",
  "result": ""
}
    

(Por cada pieza del array)

• Pieza inexistente

200 OK

{
  "success": true,
  "message": "Success",
  "result": "[{\"success\":false,\"message\":\"Error interno.: No se encontró la pieza: 123
  45\",\"result\":\"\"},{\"success\":false,\"message\":\"Error interno.: No se encontró la pi
  eza: 6789\",\"result\":\"\"}]"
}
    

• Pieza sin acuse

200 OK

{
  "success": true,
  "message": "Success",
  "result": "[{\"success\":false,\"message\":\"Error interno.: No existe el Acuse de la Pie
  za solicitada.\",\"result\":\"\"}]"
}
    

Ejemplo de request

curl -X 'POST' \
'https://www1.oca.com.ar/ApiPostal/OCAGEOApiController/GetAcusesByNumeroPiez
a?devolverUrl=true' \
-H 'accept: */*' \
-H 'Authorization: bearer TU-TOKEN\
-H 'Content-Type: application/json' \
-d '{
  "numerosPiezas": [
  "0000000162907918","0000000163125611" ]
}'
                  

Ejemplo de response

200 OK

{
  "success": true,
  "message": "Success",
  "result": "[{\"success\":false,\"message\":\"Error interno.: No existe el
  Acuse de la Pieza
  solicitada.\",\"result\":\"\"},{\"success\":true,\"message\":\"Success\",\"
  result\":\"https://www3.oca.com.ar/Digitalizacion/Imagen/ver?id=13249
  8064&op=0&clase=ACUSES&rdp=&cli=BCD&fecha=\"}]"
}
                  

El siguiente apartado contiene algunos ejemplos de posibles combinaciones de endpoints. Tener en cuenta que cada endpoint puede utilizarse de manera independiente en caso de contar con los datos necesarios.

Flujo 1: Crear pieza común

Este flujo puede aplicarse sobre cualquier tipo de pieza, teniendo en cuenta que la acción debe estar permitida para la misma.

1. Crear pieza
• Endpoint: POST
  https://test.oca.com.ar/ApiPostal/OCAGEOApiController/CrearPieza
• Request:

curl -X 'POST' \
'https://test.oca.com.ar/ApiPostal/OCAGEOApiController/CrearPieza' \
-H 'accept: */*' \
-H 'Authorization: bearer TOKEN' \
-H 'Content-Type: application/json' \
-d '{
  "retrocompatibilidad": true,
  "tipoPieza": "1",
  "numeroPieza": "1101",
  "producto": "PRODTEST",
  "sucursalCliente": "0000000001",
  "sucursalOCA": "ABW",
  "tipoDocumento": "DNI",
  "numeroDocumento": "38988766",
  "apellido": "Barrios",
  "nombre": "Roxana",
  "sexo": "F",
  "observaciones": "",
  "calle": "Entre Ríos",
  "numero": "1192",
  "piso": "1",
  "departamento": "B",
  "torre": "",
  "entrecalles": "",
  "codigoPostal": "1080",
  "localidad": "San Cristobal",
  "provincia": "Buenos Aires",
  "telefono": "",
  "telefonoLaboral": "",
  "telefonoCelular": "1112467891",
  "email": "mail@email.com",
  "fechaVisita": "",
  "codigoRangoHorario": "2",
  "codigoAccionAutomatica": "",
  "vinculoConPaquete": "",
  "clavePiezaCliente": ""
}'
                      

• Response:
  200 OK

{
  "identificadorPieza": "G0000251889520",
  "status": {
    "codigo": 1,
    "texto": "Ok"
  }
}
                      

2. Ingresar acción 24 sobre pieza
• Endpoint: POST
  https://test.oca.com.ar/ApiPostal/OCAGEOApiController/IngresarAccionV2
• Request:

curl -X 'POST' \
    'https://test.oca.com.ar/ApiPostal/OCAGEOApiController/IngresarAccionV2' \
    -H 'accept: */*' \
    -H 'Authorization: bearer TOKEN' \
    -H 'Content-Type: application/json' \
    -d '{
    "retrocompatibilidad": false,
    "piezasAcciones": [
  {
  "producto": "PRODTEST",
  "numeroPieza": "1101",
  "identificadorPieza": "",
  "idPieza": 0,
  "idAccion": 24,
  "filler": {
    "nombre": "María Roxana",
    "apellido": "",
    "tipoDocumento": "",
    "numeroDocumento": "",
    "telefono": "",
    "celular": "1122334455",
    "mail": "barrios.m@gmail.com"
  }
  }],
  "cancelaAccionPrevia": true
}'
                      

• Response:
  200 OK

{
  "success": true,
  "message": "Success",
  "result": "{\"Piezas\":[{\"Producto\":\"PRODTEST\",\"NumeroPieza\":\"1101\",\"Identificad
  orPieza\":\"\",\"IdPieza\":0,\"IdAccion\":24,\"StatusAccion\":{\"Codigo\":1,\"Texto\":\"OK\
  "}}],\"CantidadAccionesEnviadas\":1,\"CantidadAccionesRechazadas\":0,\"Status\":{\"Codigo\"
  :1,\"Texto\":\"OK\"}}"
}
                      

3. Consultar historial de la pieza
• Endpoint: POST
  https://test.oca.com.ar/ApiPostal/OCAGEOApiController/HistorialSeguimiento
• Request:

curl -X 'POST' \
  'https://test.oca.com.ar/ApiPostal/OCAGEOApiController/HistorialSeguimiento' \
  -H 'accept: */*' \
  -H 'Authorization: bearer TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "retrocompatibilidad": true,
  "identificadorPieza": "",
  "idpieza": 0,
  "numeroPieza": "1101"
}'
                      

• Response:
  200 OK

{
  "Status": {
    "Codigo": 1,
    "Texto": "Ok"
  },
  "Historiales": [
  {
    "historial": [
    {
      "fechaEstadoSolicitud": "06/12/2024 16:51:56",
      "estadoDescripcion": "Lógico Recibido",
      "motivoDescripcion": "Sin Motivo",
      "usuario": "API OCAGEO TEST, .(OCA_APIGEO)",
      "fechaEjecucion": "",
      "respuesta": "",
      "motivo": "",
      "tipo": "ESTADO",
      "idEstadoPiezaOCA": 29,
      "idMotivoPiezaOCA": 0,
      "codigoEstadoWebOCA": 1,
      "estadoWebOCA": "En proceso de Retiro",
      "codigoEstadoMotivoUnificadoOCA": 10,
      "descripcionEstadoMotivoUnificado": "Al Aguardo del Físico"
    },
    {
      "fechaEstadoSolicitud": "06/12/2024 16:54:07",
      "estadoDescripcion": "Modificacion de Datos Destinatarios",
      "motivoDescripcion": "",
      "usuario": "API OCAGEO TEST, .(OCA_APIGEO)",
      "fechaEjecucion": "06/12/2024 16:54:07",
      "respuesta": "Ejecutada con éxito",
      "motivo": "",
      "tipo": "ACCION",
      "idEstadoPiezaOCA": null,
      "idMotivoPiezaOCA": null,
      "codigoEstadoWebOCA": null,
      "estadoWebOCA": "",
      "codigoEstadoMotivoUnificadoOCA": null,
      "descripcionEstadoMotivoUnificado": ""
    }
    ],
    "idPieza": 251889520
  }
  ]
}
                      

Flujo 2: Crear un paquete

El siguiente flujo puede aplicarse para crear un paquete, crear sus componentes y establecer la vinculación.

1. Crear paquete (tipo 3) con sus componentes
• Endpoint: POST
  https://test.oca.com.ar/ApiPostal/OCAGEOApiController/CrearPieza
• Request:

                        curl -X 'POST' \
                          'https://test.oca.com.ar/ApiPostal/OCAGEOApiController/CrearPieza' \
                          -H 'accept: */*' \
                          -H 'Authorization: bearer TOKEN' \
                          -H 'Content-Type: application/json' \
                          -d '{
                            "retrocompatibilidad": false,
                            "tipoPieza": "3",
                            "numeroPieza": "1099",
                            "producto": "PAQTEST1",
                            "sucursalCliente": "0000000000",
                            "sucursalOCA": "ABW",
                            "tipoDocumento": "DNI",
                            "numeroDocumento": "25987789",
                            "apellido": "Maronna",
                            "nombre": "Jorge",
                            "sexo": "M",
                            "observaciones": "",
                            "calle": "Entre Ríos",
                            "numero": "1192",
                            "piso": "4",
                            "departamento": "B",
                            "torre": "",
                            "entrecalles": "",
                            "codigoPostal": "1080",
                            "localidad": "San Cristobal",
                            "provincia": "Caba",
                            "telefono": "",
                            "telefonoLaboral": "",
                            "telefonoCelular": "1112467891",
                            "email": "",
                            "fechaVisita": "",
                            "codigoRangoHorario": "1",
                            "codigoAccionAutomatica": "",
                            "vinculoConPaquete": "",
                            "clavePiezaCliente": "",
                            "atributosCliente": [],
                            "componentes": [
                          {
                            "productoComponente": "COMPOTEST1",
                            "vinculoComponente": "V1234"
                          }]
                        }'
                      

• Response:
  200 OK

{
  "success": true,
  "message": "Success",
  "result": "{\"IdentificadorPieza\":\"G0000251889518\",\"Status\":{\"Codigo\":1,\"Texto\":
  \"Ok\"}}"
}
                      

2. Crear componente (tipo 4) y vincularlo a paquete. Realizar este paso por cada componente del paquete.
• Endpoint: POST
  https://test.oca.com.ar/ApiPostal/OCAGEOApiController/CrearPieza
• Request:

curl -X 'POST' \
'https://test.oca.com.ar/ApiPostal/OCAGEOApiController/CrearPieza' \
-H 'accept: */*' \
-H 'Authorization: bearer TOKEN \
-H 'Content-Type: application/json' \
  -d '{
  "retrocompatibilidad": true,
  "tipoPieza": "4",
  "numeroPieza": "1100",
  "producto": "COMPOTEST1",
  "sucursalCliente": "0000000000",
  "sucursalOCA": "ABW",
  "tipoDocumento": "DNI",
  "numeroDocumento": "45648798",
  "apellido": "Mastropiero",
  "nombre": "Rodrigo",
  "sexo": "M",
  "observaciones": "",
  "calle": "Entre Ríos",
  "numero": "1192",
  "piso": "4",
  "departamento": "B",
  "torre": "",
  "entrecalles": "",
  "codigoPostal": "1080",
  "localidad": "San Cristobal",
  "provincia": "",
  "telefono": "",
  "telefonoLaboral": "",
  "telefonoCelular": "1112467891",
  "email": "mail@email.com",
  "fechaVisita": "",
  "codigoRangoHorario": "1",
  "codigoAccionAutomatica": "",
  "vinculoConPaquete": "V1234",
  "clavePiezaCliente": ""
}'
                      

• Response:
  200 OK

{
  "identificadorPieza": "G0000251889519",
  "status": {
    "codigo": 1,
    "texto": "Ok"
  }
}
                      

3. Ingresar acción sobre paquete. Se envía una acción 51 para indicar que el paquete se debe entregar por mostrador de una sucursal OCA.
• Endpoint: POST
• Request:

curl -X 'POST' \
'https://test.oca.com.ar/ApiPostal/OCAGEOApiController/IngresarAccionV2' \
-H 'accept: */*' \
-H 'Authorization: bearer TOKEN \
-H 'Content-Type: application/json' \
-d '{
  "retrocompatibilidad": false,
  "piezasAcciones": [
  {
    "producto": "",
    "numeroPieza": "",
    "identificadorPieza": "G0000251889518",
    "idPieza": 0,
    "idAccion": 51,
    "filler":
  {
    "sucursalOca": "FLS",
    "personasAutorizadas": "Rodrigo Mastropiero, Jorge Maronna"
  }
  }
  ],
  "cancelaAccionPrevia": true
}'
                      

• Response:
  200 OK

{
  "success": true,
  "message": "Success",
  "result": "{\"Piezas\":[{\"Producto\":\"\",\"NumeroPieza\":\"\",\"IdentificadorPieza\":\"
  G0000251889518\",\"IdPieza\":0,\"IdAccion\":51,\"StatusAccion\":{\"Codigo\":1,\"Texto\":\"O
  K\"}}],\"CantidadAccionesEnviadas\":1,\"CantidadAccionesRechazadas\":0,\"Status\":{\"Codigo
  \":1,\"Texto\":\"OK\"}}"
}
                      

Flujo 3: Buscar pieza por documento e ingresar acción

Este ejemplo muestra cómo se podría utilizar los distintos endpoints para extraer datos de la pieza y trabajar con la misma. Si la pieza ya fue entregada y su acuse digitalizado, puede ser consultado.

1. Buscar pieza por documento
• Endpoint: POST
  https://test.oca.com.ar/ApiPostal/OCAGEOApiController/PiezasPorDocumento
• Request:

 curl -X 'POST' \
  'https://test.oca.com.ar/ApiPostal/OCAGEOApiController/PiezasPorDocumento' \
  -H 'accept: */*' \
  -H 'Authorization: bearer TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "retrocompatibilidad": true,
  "cantidadMeses": 4,
  "estadosNoTerminal": true,
  "tipoDocumento": "",
  "numeroDocumento": "11111112",
  "producto": "",
  "operativa": ""
}'
                      

• Response:
  200 OK

{
  "Status": {
    "Codigo": 1,
    "Texto": "Ok"
  },
  "Piezas": [
    {
      "numeroPieza": "1317226",
      "destinatario": "CARICATI JUAN PABLO .",
      "operativa": "Operativa Test",
      "idPieza": 251013972,
      "fechaInclusion": "11/08/2024 09:15:04",
      "idTipoPieza": 1,
      "idPiezaTitular": null,
      "estadoMotivoOCA": "Visita/No Responde",
      "fechaEstado": "24/08/2024 12:02:00",
      "producto": "PRODTEST-Producto Test",
      "codigoEstadoCliente": "",
      "estadoCliente": "",
      "idEstadoPiezaOCA": 10,
      "idMotivoPiezaOCA": 7,
      "codigoProducto": "PRODTEST",
      "identificadorPiezaOCA": "G0000251013972",
      "terminal": false,
      "codigoEstadoWebOCA": 10,
      "estadoWebOCA": "No entregado",
      "codigoEstadoMotivoUnificadoOCA": 2,
      "descripcionEstadoMotivoUnificado": "Visita: Imposible de Entregar",
      "domicilio": "PJE ALTO DEL MONTE/CALLE PUBLICA SN 0 Torre: CP: 5887 EL ALTO CORDO
      BA",
      "sucursalOCA": "VCP (SUCURSAL OCA: VILLA CARLOS PAZ)",
      "sucursalCliente": "0000000001",
      "descripcion_DomicilioSucOCA": "AV. URUGUAY 108 CP: 5152 VA.CARLOS PAZ CORDOBA",
      "descripcion_DomicilioSucCliente": "Centro - Florida 99 CP: 1000 Capital Federal"
    }
  ]
}
                      

2. Consultar historial de la pieza
• Endpoint: POST
  https://test.oca.com.ar/ApiPostal/OCAGEOApiController/HistorialSeguimiento
• Request:

curl -X 'POST' \
  'https://test.oca.com.ar/ApiPostal/OCAGEOApiController/HistorialSeguimiento' \
  -H 'accept: */*' \
  -H 'Authorization: bearer TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "retrocompatibilidad": true,
  "identificadorPieza": "G0000251013972",
  "idpieza": 0,
  "numeroPieza": "1317226"
}'
                      

• Response:
  200 OK

{
  "Status": {
    "Codigo": 1,
    "Texto": "Ok"
  },
  "Historiales": [
    {
      "historial": [
        {
          "fechaEstadoSolicitud": "11/08/2024 09:15:04",
          "estadoDescripcion": "Lógico Recibido",
          "motivoDescripcion": "Sin Motivo",
          "usuario": "Usuario para inclusión. 6MD, SISTEMAS(SISTEMAS)",
          "fechaEjecucion": "",
          "respuesta": "",
          "motivo": "",
          "tipo": "ESTADO",
          "idEstadoPiezaOCA": 29,
          "idMotivoPiezaOCA": 0,
          "codigoEstadoWebOCA": 1,
          "estadoWebOCA": "En proceso de Retiro",
          "codigoEstadoMotivoUnificadoOCA": 10,
          "descripcionEstadoMotivoUnificado": "Al Aguardo del Físico"
        },
        {
          "fechaEstadoSolicitud": "12/08/2024 08:25:15",
          "estadoDescripcion": "Fisico Recibido",
          "motivoDescripcion": "Sin Motivo",
          "usuario": "ZARAOS, DANIEL(78343)",
          "fechaEjecucion": "",
          "respuesta": "",
          "motivo": "",
          "tipo": "ESTADO",
          "idEstadoPiezaOCA": 42,
          "idMotivoPiezaOCA": 0,
          "codigoEstadoWebOCA": 3,
          "estadoWebOCA": "En Proceso en OCA",
          "codigoEstadoMotivoUnificadoOCA": 14,
          "descripcionEstadoMotivoUnificado": "En Proceso en Plantas de OCA"
        },
        {
          "fechaEstadoSolicitud": "12/08/2024 08:34:24",
          "estadoDescripcion": "A Enviar a Sucursal Oca",
          "motivoDescripcion": "Sin Motivo",
          "usuario": "ZARAOS, DANIEL(78343)",
          "fechaEjecucion": "",
          "respuesta": "",
          "motivo": "",
          "tipo": "ESTADO",
          "idEstadoPiezaOCA": 43,
          "idMotivoPiezaOCA": 0,
          "codigoEstadoWebOCA": 3,
          "estadoWebOCA": "En Proceso en OCA",
          "codigoEstadoMotivoUnificadoOCA": 14,
          "descripcionEstadoMotivoUnificado": "En Proceso en Plantas de OCA"
        },
        {
          "fechaEstadoSolicitud": "12/08/2024 12:53:08",
          "estadoDescripcion": "Despachada a Sucursal Oca",
          "motivoDescripcion": "Sin Motivo",
          "usuario": "Guaita, Fernando(103791)",
          "fechaEjecucion": "",
          "respuesta": "",
          "motivo": "",
          "tipo": "ESTADO",
          "idEstadoPiezaOCA": 41,
          "idMotivoPiezaOCA": 0,
          "codigoEstadoWebOCA": 4,
          "estadoWebOCA": "En viaje a Sucursal de Destino",
          "codigoEstadoMotivoUnificadoOCA": 13,
          "descripcionEstadoMotivoUnificado": "En viaje a Sucursal de Destino"
        },
        {
          "fechaEstadoSolicitud": "13/08/2024 10:36:00",
          "estadoDescripcion": "Recepcionada en Sucursal",
          "motivoDescripcion": "Sin Motivo",
          "usuario": "Sistema, Usuario(sistema)",
          "fechaEjecucion": "",
          "respuesta": "",
          "motivo": "",
          "tipo": "ESTADO",
          "idEstadoPiezaOCA": 38,
          "idMotivoPiezaOCA": 0,
          "codigoEstadoWebOCA": 5,
          "estadoWebOCA": "Arribado a Sucursal de Destino",
          "codigoEstadoMotivoUnificadoOCA": 12,
          "descripcionEstadoMotivoUnificado": "Arribado a Sucursal de Destino"
        },
        {
          "fechaEstadoSolicitud": "13/08/2024 10:36:00",
          "estadoDescripcion": "Programación p/Despacho",
          "motivoDescripcion": "Sin Motivo",
          "usuario": "Sistema, Usuario(sistema)",
          "fechaEjecucion": "",
          "respuesta": "",
          "motivo": "",
          "tipo": "ESTADO",
          "idEstadoPiezaOCA": 8,
          "idMotivoPiezaOCA": 0,
          "codigoEstadoWebOCA": 6,
          "estadoWebOCA": "Procesado en OCA",
          "codigoEstadoMotivoUnificadoOCA": 1,
          "descripcionEstadoMotivoUnificado": "En Distribución "
        },
        {
          "fechaEstadoSolicitud": "14/08/2024 14:37:00",
          "estadoDescripcion": "A Despachar a Calle",
          "motivoDescripcion": "Sin Motivo",
          "usuario": "Sistema, Usuario(sistema)",
          "fechaEjecucion": "",
          "respuesta": "",
          "motivo": "",
          "tipo": "ESTADO",
          "idEstadoPiezaOCA": 9,
          "idMotivoPiezaOCA": 0,
          "codigoEstadoWebOCA": 6,
          "estadoWebOCA": "Procesado en OCA",
          "codigoEstadoMotivoUnificadoOCA": 1,
          "descripcionEstadoMotivoUnificado": "En Distribución "
        },
        {
          "fechaEstadoSolicitud": "17/08/2024 16:10:00",
          "estadoDescripcion": "En Calle",
          "motivoDescripcion": "Sin Motivo",
          "usuario": "Sistema, Usuario(sistema)",
          "fechaEjecucion": "",
          "respuesta": "",
          "motivo": "",
          "tipo": "ESTADO",
          "idEstadoPiezaOCA": 45,
          "idMotivoPiezaOCA": 0,
          "codigoEstadoWebOCA": 7,
          "estadoWebOCA": "Visita a Domicilio en Curso",
          "codigoEstadoMotivoUnificadoOCA": 1,
          "descripcionEstadoMotivoUnificado": "En Distribución "
        },
        {
          "fechaEstadoSolicitud": "19/08/2024 14:47:00",
          "estadoDescripcion": "Visita",
          "motivoDescripcion": "No Responde",
          "usuario": "Sistema, Usuario(sistema)",
          "fechaEjecucion": "",
          "respuesta": "",
          "motivo": "",
          "tipo": "ESTADO",
          "idEstadoPiezaOCA": 10,
          "idMotivoPiezaOCA": 7,
          "codigoEstadoWebOCA": 10,
          "estadoWebOCA": "No entregado",
          "codigoEstadoMotivoUnificadoOCA": 2,
          "descripcionEstadoMotivoUnificado": "Visita: Imposible de Entregar"
        },
        {
          "fechaEstadoSolicitud": "19/08/2024 14:54:00",
          "estadoDescripcion": "Programación p/Despacho",
          "motivoDescripcion": "Sin Motivo",
          "usuario": "Sistema, Usuario(sistema)",
          "fechaEjecucion": "",
          "respuesta": "",
          "motivo": "",
          "tipo": "ESTADO",
          "idEstadoPiezaOCA": 8,
          "idMotivoPiezaOCA": 0,
          "codigoEstadoWebOCA": 6,
          "estadoWebOCA": "Procesado en OCA",
          "codigoEstadoMotivoUnificadoOCA": 1,
          "descripcionEstadoMotivoUnificado": "En Distribución "
        },
        {
          "fechaEstadoSolicitud": "19/08/2024 14:55:00",
          "estadoDescripcion": "Tramitando en Zona Alejada",
          "motivoDescripcion": "Sin Motivo",
          "usuario": "Sistema, Usuario(sistema)",
          "fechaEjecucion": "",
          "respuesta": "",
          "motivo": "",
          "tipo": "ESTADO",
          "idEstadoPiezaOCA": 49,
          "idMotivoPiezaOCA": 0,
          "codigoEstadoWebOCA": 7,
          "estadoWebOCA": "Visita a Domicilio en Curso",
          "codigoEstadoMotivoUnificadoOCA": 1,
          "descripcionEstadoMotivoUnificado": "En Distribución "
        },
        {
          "fechaEstadoSolicitud": "19/08/2024 14:55:00",
          "estadoDescripcion": "A Despachar a Calle",
          "motivoDescripcion": "Sin Motivo",
          "usuario": "Sistema, Usuario(sistema)",
          "fechaEjecucion": "",
          "respuesta": "",
          "motivo": "",
          "tipo": "ESTADO",
          "idEstadoPiezaOCA": 9,
          "idMotivoPiezaOCA": 0,
          "codigoEstadoWebOCA": 6,
          "estadoWebOCA": "Procesado en OCA",
          "codigoEstadoMotivoUnificadoOCA": 1,
          "descripcionEstadoMotivoUnificado": "En Distribución "
        },
        {
          "fechaEstadoSolicitud": "20/08/2024 14:49:00",
          "estadoDescripcion": "En Calle",
          "motivoDescripcion": "Sin Motivo",
          "usuario": "Sistema, Usuario(sistema)",
          "fechaEjecucion": "",
          "respuesta": "",
          "motivo": "",
          "tipo": "ESTADO",
          "idEstadoPiezaOCA": 45,
          "idMotivoPiezaOCA": 0,
          "codigoEstadoWebOCA": 7,
          "estadoWebOCA": "Visita a Domicilio en Curso",
          "codigoEstadoMotivoUnificadoOCA": 1,
          "descripcionEstadoMotivoUnificado": "En Distribución "
        },
        {
          "fechaEstadoSolicitud": "24/08/2024 12:02:00",
          "estadoDescripcion": "Visita",
          "motivoDescripcion": "No Responde",
          "usuario": "Sistema, Usuario(sistema)",
          "fechaEjecucion": "",
          "respuesta": "",
          "motivo": "",
          "tipo": "ESTADO",
          "idEstadoPiezaOCA": 10,
          "idMotivoPiezaOCA": 7,
          "codigoEstadoWebOCA": 10,
          "estadoWebOCA": "No entregado",
          "codigoEstadoMotivoUnificadoOCA": 2,
          "descripcionEstadoMotivoUnificado": "Visita: Imposible de Entregar"
        }
      ],
      "idPieza": 251013972
    }
  ]
}
                      

Los siguientes códigos de estado HTTP son comunes a todos los endpoints de la API.

Credenciales

• Cliente: TEST
• Usuario: OCA_APIGEO
• Contraseña: 1dlJuisy3c
• Perfil: OCAGEO - Administrador

Operativas y productos

Sucursales de ejemplo (para cliente)

Piezas de ejemplo

1. Nombre y apellido: Rodrigo Lopez
• idPieza: 251889515
• numeroPieza: 0000001
• Operativa:
• Producto: PRODTEST
• Tipo y número de documento: DNI 39123456
• Fecha de alta: 04/12/2024

URL de test

https://test.oca.com.ar/ApiPostal/swagger/index.html

URL Productiva

https://www1.oca.com.ar/ApiPostal/swagger/index.html