Métodos/Servicios de la API

En esta sección se presentan los conceptos clave y definiciones fundamentales del negocio que resultan esenciales para comprender el funcionamiento de la API. Incluye términos que forman parte de la lógica de negocio, con explicaciones detalladas y, en algunos casos, los posibles valores esperados en determinados endpoints.

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. Consiste en un único envío cuyo destinatario es el titular. Por ejemplo, puede ser una tarjeta de débito o un sobre.

  • Paquete: Pieza que está conformada por componentes de paquete. Puede incluir entre 1 y 22 componentes o insumos. Por ejemplo, se puede utilizar para el envío de múltiples tarjetas. El paquete es un único envío que 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. Un componente puede tener únicamente los estados / motivos "Lógico recibido" y "Físico recibido". El resto de los estados serán del paquete.

Operativa

Una operativa es un contrato comercial que se acuerda entre OCA y el cliente. Las operativas deben ser creadas por el área comercial una vez definidas las condiciones del servicio. Incluye opciones de distribución, tipos de procesos tales como retiro de piezas e impresión de acuses si corresponde, entre otros. El sector comercial debe proveer al cliente los códigos de operativas con su respectiva descripción.
Los códigos de las operativas pueden ser numéricos o alfanuméricos, por ejemplo "101293" o "VISAR".

Producto


Se refiere a los distintos productos que los clientes ofrecen a los consumidores finales, por ejemplo: Tarjeta Visa Nacional, Visa Internacional, GOLD, Premier, etc.

Los productos deben ser creados por el área de sistemas luego de que se hayan dado de alta las operativas y el cliente especifique los productos que requiere. Una vez definidos los mismos, se proveerán los códigos y las descripciones que podrán verse tanto en los sitios como en las notificaciones.

Los códigos de los productos pueden ser numéricos o alfanuméricos, por ejemplo "101293" o "VISAR". Si existe un único producto asociado a la operativa, se utilizará el mismo código para ambos.

Status Code Generales

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

Código Descripción
200 OK La solicitud se completó exitosamente. Este código también puede incluir errores de validación en la respuesta, por ejemplo, al ingresar una sucursal o una pieza inexistente.
400 Bad Request Error en los datos enviados. Verificar que el request body sea válido y que los parámetros tengan el tipo de dato correcto.
401 Unauthorized Autenticación requerida. Iniciar sesión o renovar el token si ha expirado.
403 Forbidden El usuario no tiene los permisos para utilizar el endpoint. (Ver: Login, accesos y permisos)
500 Internal Server Error Error en el servidor. Intentar nuevamente más tarde o contactarse con soporte.

Login, accesos y permisos

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:

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

Autenticación

Request

Método: POST

Entorno URL
Test https://test.oca.com.ar/ApiPostal/LoginController/loginSigma
Producción https://www1.oca.com.ar/ApiPostal/LoginController/loginSigma

Response

Status: 200 OK 
{
  "success": true,
  "message": "Success",
  "result": "TOKEN"
}

Buscar sucursales OCA

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.

Método: GET

Entorno URL
Test https://test.oca.com.ar/ApiPostal/OCAGEOApiController/ObtenerSucursalOca
Producción https://www1.oca.com.ar/ApiPostal/OCAGEOApiController/ObtenerSucursalOca

Parámetros

Datos de ubicación de la sucursal
Localidad string

Localidad donde se encuentra la sucursal. Si la provincia es "CAPITAL FEDERAL", el campo localidad puede ser este mismo valor o un barrio.

Ejemplo: "PILAR"
Provincia string

Provincia donde se encuentra la sucursal.

Ejemplo: "BUENOS AIRES"

Request

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

Response

Status: 200 OK 
    [
     {
      "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"
     }
    ]

Creación de una pieza

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

Entorno URL
Test https://test.oca.com.ar/ApiPostal/OCAGEOApiController/CrearPieza
Producción https://www1.oca.com.ar/ApiPostal/OCAGEOApiController/CrearPieza

Request Body

retrocompatibilidad boolean Obligatorio

Mediante este parámetro elegimos el formato de la response. En caso de encontrarse vacío, se devolverá un 400 Bad Request. true devuelve un formato 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.

Ejemplo: false
tipoPieza string Obligatorio

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

Longitud máxima: 3

Ejemplo: "3"
numeroPieza string Obligatorio

Identificador de la pieza determinado por el cliente.

Longitud máxima: 30

Ejemplo: "432123564532"
producto string Obligatorio

Código del producto. Este debe ser previamente acordado con OCA ya que los productos son configurados dentro de una operativa.

Longitud máxima: 10

Ejemplo: "120032"
sucursalCliente string Obligatorio

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.

Longitud máxima: 10

Ejemplo: "0000000001"
sucursalOca string

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.

Longitud máxima: 5

Ejemplo: "MRO"
tipoDocumento string

Tipo de documento del destinatario (DNI, CUIT, CUIL, DU, PAS, LE).

Longitud máxima: 5

Ejemplo: "DNI"
numeroDocumento string

Número de documento del destinatario.

Longitud máxima: 20

Ejemplo: "39899788"
apellido string Obligatorio

Apellido del destinatario.

Longitud máxima: 20

Ejemplo: "Lopez"
nombre string

Nombre del destinatario.

Longitud máxima: 60

Ejemplo: "Pablo"
sexo string

Sexo del destinatario. Los valores posibles son M, F o X. Si no se incluye, por defecto será M.

Longitud máxima: 2

Ejemplo: "F"
observaciones string

Cualquier aclaración necesaria sobre el envío de la pieza.

Longitud máxima: 200

Ejemplo: "Entregar al portero."
calle string Obligatorio

Calle del domicilio del destinatario.

Longitud máxima: 50

Ejemplo: "Av. Entre Ríos"
numero string

Número del domicilio del destinatario.

Longitud máxima: 10

Ejemplo: "3601"
piso string

Piso del domicilio del destinatario.

Longitud máxima: 3

Ejemplo: "5"
departamento string

Departamento del domicilio del destinatario.

Longitud máxima: 4

Ejemplo: "C"
torre string

Torre del domicilio del destinatario.

Longitud máxima: 2

Ejemplo: "A"
entrecalles string

Las entre calles del domicilio del destinatario.

Longitud máxima: 100

Ejemplo: "Av. Callao y Talcahuano"
codigoPostal string Obligatorio

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.

Longitud máxima: 8

Ejemplo: "1213"
localidad string Obligatorio

Localidad del domicilio del destinatario.

Longitud máxima: 40

Ejemplo: "Cordoba capital"
provincia string Obligatorio

Provincia del domicilio del destinatario.

Longitud máxima: 30

Ejemplo: "Buenos Aires"
telefono string

Teléfono del destinatario. Ingresar sin espacios o caracteres especiales.

Longitud máxima: 30

Ejemplo: "4663968"
telefonoLaboral string

Teléfono laboral del destinatario. Ingresar sin espacios o caracteres especiales.

Longitud máxima: 30

Ejemplo: "08004332849"
telefonoCelular string

Teléfono celular del destinatario. Ingresar sin espacios o caracteres especiales.

Longitud máxima: 30

Ejemplo: "1122948767"
email string

Email del destinatario.

Longitud máxima: 80

Ejemplo: "usuario.ejemplo@gmail.com"
fechaVisita string

Fecha en la cual se pacta con OCA la entrega de la pieza al destinatario.

Longitud máxima: 10

Ejemplo: "10/12/2024"
codigoRangoHorario string Obligatorio

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

Longitud máxima: 1

Ejemplo: "2"
codigoAccionAutomatica string

Código mediante el cual indicamos la ejecución de una acción de forma automática. Valores posibles: 17, 19, 32, 36.

Longitud máxima: 4

Ejemplo: "17"
vinculoConPaquete string

Se utiliza cuando la pieza es un Componente de paquete (tipo 4). Recibe un valor para generar su vinculación hacia el paquete correspondiente. No se requiere cuando la pieza es normal (tipo 1) o paquete (tipo 3).

Longitud máxima: 30

Ejemplo: "C11411241"
clavePiezaCliente string

Clave o código de unicidad utilizado para identificar las piezas y evitar la repetición del numeroPieza en el sistema.

Longitud máxima: 50

Ejemplo: "cxyqmt154367"
atributosCliente Array<Object>

Array de objetos que puede ser utilizado para informar algún dato adicional con un fin específico dentro del circuito del sistema, por ejemplo: límite de compras, número de cuenta, datos para imprimir contratos o formularios, etc.

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

Nombre del atributo adicional.

Longitud máxima: 100

Ejemplo: "lugarRetiro"
valor string

Valor del atributo adicional.

Longitud máxima: 100

Ejemplo: "0112374F"
componentes Array<Componente>

Se utiliza cuando la pieza es Paquete de Producto (tipo 3) para informar los diferentes componentes que van a conformar al mismo. Cada objeto representa un componente.

Longitud máxima: 22

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

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.

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

Código del producto del componente. Debe ser un producto existente.

Longitud máxima: 20

Ejemplo: "VISAN"
vinculoComponente string

Código que vincula el paquete y el componente. Al crear el componente, este mismo valor irá en el parámetro vinculoConPaquete.

Longitud máxima: 30

Ejemplo: "L01235592"

Request

Ejemplo de request cURL 
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 cURL 
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": false,
  "tipoPieza": "3",
  "numeroPieza": "9991234321",
  "producto": "COOL",
  "sucursalCliente": "0000000000",
  "sucursalOCA": "",
  "tipoDocumento": "DNI",
  "numeroDocumento": "25987789",
  "apellido": "Maronna",
  "nombre": "Jorge",
  "sexo": "M",
  "observaciones": "",
  "calle": "La Rioja",
  "numero": "301",
  "piso": "4",
  "departamento": "B",
  "torre": "",
  "entrecalles": "",
  "codigoPostal": "1214",
  "localidad": "Once",
  "provincia": "Caba",
  "telefono": "",
  "telefonoLaboral": "",
  "telefonoCelular": "1112467891",
  "email": "",
  "fechaVisita": "",
  "codigoRangoHorario": "1",
  "codigoAccionAutomatica": "",
  "vinculoConPaquete": "",
  "clavePiezaCliente": "",
  "atributosCliente": [],
  "componentes": [
    {
      "productoComponente": "100575",
      "vinculoComponente": "123456"
    },
    {
      "productoComponente": "100574",
      "vinculoComponente": "987654"
    }
  ]
}'

Ejemplo de request cURL 
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": ""
}'

Response

Ejemplo de respuesta exitosa

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

Ejemplo de respuesta exitosa con retrocompatibilidad: true

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

Errores

Ejemplo de response con errores

Status: 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."
    ]
  }
}


La siguiente tabla muestra una lista de los posibles mensajes de error que pueden ser devueltos como resultado de errores de validación:

Código HTTP Mensaje Descripción
200 Error interno.: El atributo Codigo de Producto es Invalido producto inexistente.
200 Error interno.: \"Atención! La SucursalCliente 0009090979 no existe, se asignó la CasaCentral. Identificador pieza: G0000251889514\" sucursalCliente inexistente (se asigna a casa central)
200 Error interno.: La SucursalOCA no existe o no se encuentra habilitada. sucursalOCA inexistente / deshabilitada
200 Error interno.: El codigo postal no es correcto. codigo postal inválido
200 Error interno.: Sexo invalido, debe ingresar M, F o X. sexo inválido
200 Error interno.: El atributo Codigo de Accion Automatica es Invalida codigoAccionAutomatica inválido
200 Error interno.: \"Pieza Nro. 3000890 existente para el Campo Clave 3543434 con el identificador de OCA G0000251889446\" clavePiezaCliente existente para un número de pieza
200 Error al validar el campo Fecha de Visita - La Fecha elegida debe estar dentro de los 15 días a partir de Mañana fechaVisita mayor a 15 días
400 Tipo Pieza invalido. fidTipoPieza inexistente
400 El campo solo acepta números. codigoPostal con letras
400 El campo solo puede contener los valores '1', '2' o '3'." codigoRangoHorario inválido

En la siguiente tabla se listan todos los posibles errores específicos para piezas de tipo paquete:

Código HTTP Mensaje Descripción
200 Error interno.: \"OkAdvertencia! Los productos ABC, de los componentes son inexistentes \" productoComponente inexistente
200 Error interno.: Error! El producto TVALSB no es del tipo paquete, no se puede crear la pieza El valor de producto ingresado no es de tipo paquete.
400 La pieza de tipo 3 no puede tener mas de 22 componentes. El paquete superó el número máximo de componentes (22)


Buscar piezas por número de documento

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

Entorno URL
Test https://test.oca.com.ar/ApiPostal/OCAGEOApiController/PiezasPorDocumento
Producción https://www1.oca.com.ar/ApiPostal/OCAGEOApiController/PiezasPorDocumento

Request body

retrocompatibilidad boolean

Mediante este parámetro elegimos el formato de la response. En caso de encontrarse vacío, se devolverá un 400 Bad Request. true devuelve un formato 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.

Ejemplo: false
cantidadMeses int

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. Por ejemplo, ingresar 1 buscará piezas tanto del mes actual como del anterior. El valor por defecto es 6.

Ejemplo: 5
estadosNoTerminal boolean

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). Si no se envía este parámetro, no se filtrará por tipos de estado.

Ejemplo: true
tipoDocumento string

Tipo de documento del destinatario.

Longitud máxima: 5

Ejemplo: "DNI"
numeroDocumento string Obligatorio

Número de documento del destinatario.

Longitud máxima: 20

Ejemplo: "39888999"
producto string

Código de producto. Este valor es configurado previamente para el cliente desde OCA.

Longitud máxima: 10

Ejemplo: "110229"
operativa string

Código de operativa. La misma es confeccionada por el Comercial y luego se habilita para el uso por parte del Cliente.

Longitud máxima: 10

Ejemplo: "110229"

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": true,
  "cantidadMeses": 6,
  "estadosNoTerminal": true,
  "tipoDocumento": "DNI",
  "numeroDocumento": "38883388",
  "producto": "",
  "operativa": ""
}'

Response

Ejemplo de respuesta exitosa

Status: 200 OK 
{
  "success": true,
  "message": "Success",
  "result": "[{\"NumeroPieza\":\"5197140023580562\",\"FechaEstado\":\"21/08/2025 10:01:00\",\"Operativa\":\"Master Exclusive\",\"Producto\":\"MASTEXCLRI-MASTER EXCLUSIVE REIMPRESION\",\"IdPieza\":251702624,\"Destinatario\":\"SUAREZ MARISA \",\"FechaInclusion\":\"21/08/2025 10:01:00\",\"EstadoMotivoOCA\":\"A Enviar a Sucursal Oca/Sin Motivo\",\"CodigoEstadoCliente\":\"\",\"EstadoCliente\":\"\",\"IDEstadoPiezaOCA\":43,\"IDMotivoPiezaOCA\":0,\"CodigoProducto\":\"MASTEXCLRI\",\"CodigoEstadoWebOCA\":3,\"CodigoEstadoMotivoUnificadoOCA\":14,\"DescripcionEstadoMotivoUnificado\":\"En Proceso en Plantas de OCA\",\"Domicilio\":\"Entre Ríos 01684 Torre:    CP: 1714 ITUZAINGO \",\"Descripcion_DomicilioSucOCA\":\"\",\"Descripcion_DomicilioSucCliente\":\"(0519)-BANCO ICBC - ALMAFUERTE 3138 CP: 001754 SAN JUSTO\",\"NumeroDocumento\":\"38883388\",\"IdTipoPieza\":2,\"SucursalOCA\":\"\",\"SucursalCliente\":\"0000000519\",\"IdentificadorPiezaOCA\":\"G0000251702624\",\"EstadoWebOCA\":\"En Proceso en OCA\",\"IdPiezaTitular\":251702501,\"Terminal\":false,\"PiezaTitular\":{\"NumeroPieza\":\"5197140023568922\",\"Destinatario\":\"ARTAZA MATIAS RAUL \",\"IdPieza\":251702501,\"IdTipoPieza\":1,\"IdentificadorPiezaOCA\":\"G0000251702501\",\"EstadoMotivoOCA\":\"A Enviar a Sucursal Oca/Sin Motivo\",\"FechaEstado\":\"24/04/2023 08:55:05\",\"Producto\":\"MASTEXCLRI-MASTER EXCLUSIVE REIMPRESION\",\"Operativa\":\"Master Exclusive\",\"CodigoEstadoCliente\":\"\",\"EstadoCliente\":\"\",\"IDEstadoPiezaOCA\":43,\"IDMotivoPiezaOCA\":0,\"NumeroDocumento\":\"34344543\"}}]"
}

Ejemplo de respuesta exitosa con retrocompatibilidad: true

Status: 200 OK 
{
  "Status": {
    "Codigo": 1,
    "Texto": "Ok"
  },
  "Piezas": [
    {
      "numeroPieza": "5197140023580562",
      "fechaEstado": "21/08/2025 10:01:00",
      "operativa": "Master Exclusive",
      "producto": "MASTEXCLRI-MASTER EXCLUSIVE REIMPRESION",
      "idPieza": 251702624,
      "destinatario": "SUAREZ MARISA ",
      "fechaInclusion": "21/08/2025 10:01:00",
      "estadoMotivoOCA": "A Enviar a Sucursal Oca/Sin Motivo",
      "codigoEstadoCliente": "",
      "estadoCliente": "",
      "idEstadoPiezaOCA": 43,
      "idMotivoPiezaOCA": 0,
      "codigoProducto": "MASTEXCLRI",
      "codigoEstadoWebOCA": 3,
      "codigoEstadoMotivoUnificadoOCA": 14,
      "descripcionEstadoMotivoUnificado": "En Proceso en Plantas de OCA",
      "domicilio": "Entre Ríos 01684 Torre:    CP: 1714 ITUZAINGO ",
      "descripcion_DomicilioSucOCA": "",
      "descripcion_DomicilioSucCliente": "(0519)-BANCO ICBC - ALMAFUERTE 3138 CP: 001754 SAN JUSTO",
      "numeroDocumento": "38883388",
      "idTipoPieza": 2,
      "sucursalOCA": "",
      "sucursalCliente": "0000000519",
      "identificadorPiezaOCA": "G0000251702624",
      "estadoWebOCA": "En Proceso en OCA",
      "idPiezaTitular": 251702501,
      "terminal": false,
      "piezaTitular": {
        "numeroPieza": "5197140023568922",
        "destinatario": "ARTAZA MATIAS RAUL ",
        "idPieza": 251702501,
        "idTipoPieza": 1,
        "identificadorPiezaOCA": "G0000251702501",
        "estadoMotivoOCA": "A Enviar a Sucursal Oca/Sin Motivo",
        "fechaEstado": "24/04/2023 08:55:05",
        "producto": "MASTEXCLRI-MASTER EXCLUSIVE REIMPRESION",
        "operativa": "Master Exclusive",
        "codigoEstadoCliente": "",
        "estadoCliente": "",
        "idEstadoPiezaOCA": 43,
        "idMotivoPiezaOCA": 0,
        "numeroDocumento": "34344543"
      }
    }
  ]
}

Errores

Ejemplos de response con errores

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

Ejemplo de error con retrocompatibilidad: true

Status: 200 OK 
{
  "Status": {
    "Codigo": 9,
    "Texto": "No se encontraron Piezas"
  },
  "Piezas": []
}

Ejemplo de error 400

Status: 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."
    ]
  }
}
Código HTTP Mensaje Descripción
200 Input inválido - El Producto no es valido. El producto con el que se buscó la pieza es inexistente.
200 Input inválido - La operativa no es valida. La operativa con la que se buscó la pieza es inexistente.
400 NumeroDocumento no admite valor null. El parámetro numeroDocumento es obligatorio.
400 El rango de CantidadMeses es entre 1 y 6. Se ingresó una cantidad de meses inválida.

Consultar estado actual de una pieza

Descripción

El método estadoActual nos permite recuperar el estado actual de una pieza, sea por el id 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.

Método: POST

Entorno URL
Test https://test.oca.com.ar/ApiPostal/OCAGEOApiController/EstadoActual
Producción https://www1.oca.com.ar/ApiPostal/OCAGEOApiController/EstadoActual

Request body

retrocompatibilidad boolean Obligatorio

Mediante este parámetro elegimos el formato de la response. En caso de encontrarse vacío, se devolverá un 400 Bad Request. 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.

Ejemplo: false
producto string

Código de producto. Este valor es configurado previamente para el cliente desde OCA. Si se proporciona el producto, debe proporcionarse también el número de pieza.

Longitud máxima: 10

Ejemplo: "117992"
identificadorPieza string

Número de seguimiento único de la pieza generado por OCA al dar de alta lógicamente la pieza.

Longitud máxima: 100

Ejemplo: "G0000123456"
idPieza int

Identificador único de la pieza en la base de datos. En caso de no enviarlo, establecer el parámetro en 0.

Ejemplo: 12345
numeroPieza string

Número de la pieza asignado por parte del cliente para su seguimiento.

Longitud máxima: 30

Ejemplo: "12345"

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": "MASTEXCLRI",
  "numeroPieza": "5197140023568922",
  "identificadorPieza": "",
  "idpieza": 0
}'

Response

Ejemplo de respuesta exitosa

Status: 200 OK 
{
  "success": true,
  "message": "Success",
  "result": "[{\"PiezaTitular\":{\"NumeroPiezaCliente\":\"5197140023568922\",\"FechaEstado\":\"24/04/2023 08:55:05\",\"Operativa\":\"115981-Master Exclusive\",\"Producto\":\"MASTEXCLRI-MASTER EXCLUSIVE REIMPRESION\",\"Recibo\":\"9589893\",\"IdPieza\":251702501,\"Destinatario\":\"ARTAZA MATIAS RAUL \",\"FechaInclusion\":\"21/04/2023 10:05\",\"FechaEnvioCliente\":\"21/04/2023 10:01\",\"PlanillaEnvio\":\"\",\"FechaPlanillaEnvio\":\"\",\"EstadoMotivoOCA\":\"A Enviar a Sucursal Oca/Sin Motivo\",\"CodigoEstadoCliente\":\"0\",\"EstadoCliente\":\"\",\"IDEstadoPiezaOCA\":43,\"IDMotivoPiezaOCA\":0,\"CodigoProducto\":\"MASTEXCLRI\",\"CodigoEstadoWebOCA\":3,\"CodigoEstadoMotivoUnificadoOCA\":14,\"DescripcionEstadoMotivoUnificado\":\"En Proceso en Plantas de OCA\",\"Domicilio\":\"Entre Ríos 01684 Torre:    CP: 1714 ITUZAINGO \",\"Descripcion_DomicilioSucOCA\":\"AV. VICTORICA 1128 NINE SHOPPING LOCAL 12 -  CP: 1744 MORENO BUENOS AIRES\",\"Descripcion_DomicilioSucCliente\":\"(0519)-BANCO ICBC - ALMAFUERTE 3138 CP: 001754 SAN JUSTO\",\"NumeroDocumento\":\"34344543\",\"IdTipoPieza\":1},\"Carta\":\"\",\"FechaRendicion\":\"\",\"Cliente\":\"S1T - INDUSTRIAL AND COMERCIAL BANK OF CHINA\",\"Subservicio\":\"TG\",\"SucursalOCA\":\"\",\"SucursalCliente\":\"0000000519\",\"TipoPieza\":\"Pieza Adicional\",\"IdentificadorPiezaOCA\":\"G0000251702624\",\"EstadoWebOCA\":\"En Proceso en OCA\",\"IdPiezaTitular\":251702501,\"NumeroPiezaCliente\":\"5197140023580562\",\"FechaEstado\":\"21/08/2025 10:01:00\",\"Operativa\":\"115981-Master Exclusive\",\"Producto\":\"MASTEXCLRI-MASTER EXCLUSIVE REIMPRESION\",\"Recibo\":\"9589893\",\"IdPieza\":251702624,\"Destinatario\":\"SUAREZ MARISA \",\"FechaInclusion\":\"21/04/2023 10:05\",\"FechaEnvioCliente\":\"21/04/2023 10:01\",\"PlanillaEnvio\":\"\",\"FechaPlanillaEnvio\":\"\",\"EstadoMotivoOCA\":\"A Enviar a Sucursal Oca/Sin Motivo\",\"CodigoEstadoCliente\":\"0\",\"EstadoCliente\":\"\",\"IDEstadoPiezaOCA\":43,\"IDMotivoPiezaOCA\":0,\"CodigoProducto\":\"MASTEXCLRI\",\"CodigoEstadoWebOCA\":3,\"CodigoEstadoMotivoUnificadoOCA\":14,\"DescripcionEstadoMotivoUnificado\":\"En Proceso en Plantas de OCA\",\"Domicilio\":\"Entre Ríos 01684 Torre:    CP: 1714 ITUZAINGO \",\"Descripcion_DomicilioSucOCA\":null,\"Descripcion_DomicilioSucCliente\":\"(0519)-BANCO ICBC - ALMAFUERTE 3138 CP: 001754 SAN JUSTO\",\"NumeroDocumento\":\"38883388\",\"IdTipoPieza\":2}]"
}

Ejemplo de respuesta con retrocompatibilidad: true

Status: 200 OK 
{
  "Status": {
    "Codigo": 1,
    "Texto": "Ok"
  },
  "Piezas": [
    {
      "piezaTitular": {
        "numeroPiezaCliente": "5197140023568922",
        "fechaEstado": "24/04/2023 08:55:05",
        "operativa": "115981-Master Exclusive",
        "producto": "MASTEXCLRI-MASTER EXCLUSIVE REIMPRESION",
        "recibo": "9589893",
        "idPieza": 251702501,
        "destinatario": "ARTAZA MATIAS RAUL ",
        "fechaInclusion": "21/04/2023 10:05",
        "fechaEnvioCliente": "21/04/2023 10:01",
        "planillaEnvio": "",
        "fechaPlanillaEnvio": "",
        "estadoMotivoOCA": "A Enviar a Sucursal Oca/Sin Motivo",
        "codigoEstadoCliente": "0",
        "estadoCliente": "",
        "idEstadoPiezaOCA": 43,
        "idMotivoPiezaOCA": 0,
        "codigoProducto": "MASTEXCLRI",
        "codigoEstadoWebOCA": 3,
        "codigoEstadoMotivoUnificadoOCA": 14,
        "descripcionEstadoMotivoUnificado": "En Proceso en Plantas de OCA",
        "domicilio": "Entre Ríos 01684 Torre:    CP: 1714 ITUZAINGO ",
        "descripcion_DomicilioSucOCA": "AV. VICTORICA 1128 NINE SHOPPING LOCAL 12 -  CP: 1744 MORENO BUENOS AIRES",
        "descripcion_DomicilioSucCliente": "(0519)-BANCO ICBC - ALMAFUERTE 3138 CP: 001754 SAN JUSTO",
        "numeroDocumento": "34344543",
        "idTipoPieza": 1
      },
      "carta": "",
      "fechaRendicion": "",
      "cliente": "S1T - INDUSTRIAL AND COMERCIAL BANK OF CHINA",
      "subservicio": "TG",
      "sucursalOCA": "",
      "sucursalCliente": "0000000519",
      "tipoPieza": "Pieza Adicional",
      "identificadorPiezaOCA": "G0000251702624",
      "estadoWebOCA": "En Proceso en OCA",
      "idPiezaTitular": 251702501,
      "numeroPiezaCliente": "5197140023580562",
      "fechaEstado": "21/08/2025 10:01:00",
      "operativa": "115981-Master Exclusive",
      "producto": "MASTEXCLRI-MASTER EXCLUSIVE REIMPRESION",
      "recibo": "9589893",
      "idPieza": 251702624,
      "destinatario": "SUAREZ MARISA ",
      "fechaInclusion": "21/04/2023 10:05",
      "fechaEnvioCliente": "21/04/2023 10:01",
      "planillaEnvio": "",
      "fechaPlanillaEnvio": "",
      "estadoMotivoOCA": "A Enviar a Sucursal Oca/Sin Motivo",
      "codigoEstadoCliente": "0",
      "estadoCliente": "",
      "idEstadoPiezaOCA": 43,
      "idMotivoPiezaOCA": 0,
      "codigoProducto": "MASTEXCLRI",
      "codigoEstadoWebOCA": 3,
      "codigoEstadoMotivoUnificadoOCA": 14,
      "descripcionEstadoMotivoUnificado": "En Proceso en Plantas de OCA",
      "domicilio": "Entre Ríos 01684 Torre:    CP: 1714 ITUZAINGO ",
      "descripcion_DomicilioSucOCA": null,
      "descripcion_DomicilioSucCliente": "(0519)-BANCO ICBC - ALMAFUERTE 3138 CP: 001754 SAN JUSTO",
      "numeroDocumento": "38883388",
      "idTipoPieza": 2
    }
  ]
}

Errores

Ejemplos de response con errores

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

Response de error con retrocompatibilidad: true

Status: 200 OK 
{
  "Status": {
    "Text": "El Numero de Idpieza es Inexistente",
    "Codigo": 8
  },
  "Piezas": []
}

Ejemplo de error 400

Status: 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, IdentificadorPieza o Idpieza)."
    ]
  }
}
Código HTTP Mensaje Descripción
200 Error interno.: 8 - El Numero de Idpieza es Inexistente Parámetro idPieza inexistente
200 Error interno.: 9 - El Identificador de Idpieza es Inexistente Parámetro identificadorPieza inexistente
200 Error interno.: 10 - El Numero de Pieza es inexistente Parámetro numeroPieza inexistente
200 Error interno.: 7 - No existe el producto ingresado El producto con el que se buscó la pieza es inexistente.
400 Si se proporciona un producto, también debe proporcionarse un número de pieza. Se ingresó únicamente el parámetro producto sin ingresar numeroPieza
400 Al menos uno de los campos debe ser proporcionado (Producto, NumeroPieza, IdentificadorPieza o Idpieza). No se ingresó ningún parámetro para realizar la búsqueda.

Consultar tracking de una 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

Entorno URL
Test https://test.oca.com.ar/ApiPostal/OCAGEOApiController/HistorialSeguimiento
Producción https://www1.oca.com.ar/ApiPostal/OCAGEOApiController/HistorialSeguimiento

Request body

retrocompatibilidad boolean Obligatorio

Mediante este parámetro elegimos el formato de la response. En caso de encontrarse vacío, se devolverá un 400 Bad Request. 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.

Ejemplo: false
identificadorPieza string

Número de seguimiento de la pieza generado por OCA al dar de alta lógicamente la pieza.

Longitud máxima: 100

Ejemplo: "G0000123456"
idPieza int

Identificador único de la pieza en la base de datos. En caso de no enviarlo, establecer el parámetro en 0.

Ejemplo: 12345
numeroPieza string

Número de la pieza asignado por parte del cliente.

Longitud máxima: 30

Ejemplo: "12345"

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

Response

Ejemplo de respuesta exitosa

Status: 200 OK 
{
  "success": true,
  "message": "Success",
  "result": "[{\"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}]"
}

Ejemplo de respuesta con retrocompatibilidad: true

Status: 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
    }
  ]
}

Errores

Ejemplos de response con errores

Status: 200 OK 
{
  "success": false,
  "message": "Error interno.: 8 - El Numero de Idpieza es Inexistente",
  "result": ""
}

Response de error con retrocompatibilidad: true

Status: 200 OK 
{
  "Status": {
    "Text": "El Numero de Idpieza es Inexistente",
    "Codigo": 8
  },
  "Historiales": []
}

Ejemplo de error 400

Status: 400 BAD REQUEST 
{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "errors": {
    "Idpieza": [
      "Al menos uno de los campos debe tener un valor válido."
    ],
    "NumeroPieza": [
      "Al menos uno de los campos debe tener un valor válido."
    ],
    "IdentificadorPieza": [
      "Al menos uno de los campos debe tener un valor válido."
    ]
  },
  "traceId": "00-5ae65af3756b24c8181452d74b37d93b-72f30d9b4f9d59c6-00"
}
Código HTTP Mensaje Descripción
200 Error interno.: 8 - El Numero de Idpieza es Inexistente Parámetro idPieza inexistente
200 Error interno.: 9 - El Identificador de Idpieza es Inexistente Parámetro identificadorPieza inexistente
200 Error interno.: 10 - El Numero de Pieza es inexistente Parámetro numeroPieza inexistente
400 Al menos uno de los campos debe tener un valor válido. No se ingresó ningún parámetro para realizar la búsqueda.

Accionar sobre una pieza

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

Entorno URL
Test https://test.oca.com.ar/ApiPostal/OCAGEOApiController/IngresarAccionV2
Producción https://www1.oca.com.ar/ApiPostal/OCAGEOApiController/IngresarAccionV2

Request body

retrocompatibilidad boolean Obligatorio

Mediante este parámetro elegimos el formato de la response. En caso de encontrarse vacío, se devolverá un 400 Bad Request. 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.

Ejemplo: false
piezasAcciones array<PiezaAccion> Obligatorio

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.

Longitud máxima: 100

Ejemplo: 
[
  {
    "producto": "100575",
    "numeroPieza": "PAQ113",
    "identificadorPieza": "G0000251803247",
    "idPieza": 251803247,
    "idAccion": 17,
    "filler": {
      "Observaciones": "Test filler ingresarAccionV2"
    }
  }
]
cancelarAccionPrevia boolean Obligatorio

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.

Ejemplo: true
piezaAccion object Obligatorio

Objeto que indica la pieza y la acción que se ejecutará sobre la misma. Se encuentra dentro del array piezasAcciones.

Ejemplo: 
{
  "producto": "100575",
  "numeroPieza": "PAQ113",
  "identificadorPieza": "G0000251803247",
  "idPieza": 251803247,
  "idAccion": 17,
  "filler": {
    "Observaciones": "Test filler ingresarAccionV2"
  }
}
producto string

Código de producto. Este valor es configurado previamente para el cliente desde OCA.

Longitud máxima: 100

Ejemplo: "102110"
numeroPieza string

Número de la pieza asignado por parte del cliente.

Longitud máxima: 100

Ejemplo: "00012345431123"
identificadorPieza string

Número de seguimiento de la pieza generado por OCA al dar de alta lógicamente la pieza.

Longitud máxima: 100

Ejemplo: "G00001235421"
idPieza int

Identificador único de la pieza en la base de datos. En caso de no enviarlo, establecer el parámetro en 0.

Ejemplo: 54324512
idAccion int Obligatorio

Identificador único de la acción a realizar.

Ejemplo: 17
filler object Obligatorio

Objeto que contiene parámetros adicionales requeridos según el idAccion. El filler debe corresponder al idAccion ingresado.

Ejemplo: 
{
  "Observaciones": "Test filler ingresarAccionV2"
}

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"
      }
    }
  ],
  "cancelarAccionPrevia": true
}'

Response

Ejemplo de respuesta exitosa

Status: 200 OK 
{
  "success": true,
  "message": "Success",
  "result": "{\"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\"}}"
}

Ejemplo de respuesta con retrocompatibilidad: true

Status: 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"
  }
}

Errores

Ejemplos de response con errores

Status: 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 especificar un Numero de Pieza, Identificador de Pieza, o Idpieza a buscar\"}}],\"CantidadAccionesEnviadas\":1,\"CantidadAccionesRechazadas\":1,\"Status\":{\"Codigo\":-1,\"Texto\":\"Algunas acciones no pudieron ingresarse, revise en la lista de resultado.\"}}"
}

Response de error con retrocompatibilidad: true

Status: 200 OK 
{
  "piezas": [
    {
      "producto": "",
      "numeroPieza": "",
      "identificadorPieza": "",
      "idPieza": 0,
      "idAccion": 0,
      "statusAccion": {
        "codigo": -1,
        "texto": "6 - Debe especificar un Numero de Pieza, Identificador de Pieza, o Idpieza a buscar"
      }
    }
  ],
  "cantidadAccionesEnviadas": 1,
  "cantidadAccionesRechazadas": 1,
  "status": {
    "codigo": -1,
    "texto": "Algunas acciones no pudieron ingresarse, revise en la lista de resultado."
  }
}

Ejemplo de error 400

Status: 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."
    ]
  }
}
Código HTTP Mensaje Descripción
200 6 - Debe especificar un Numero de Pieza, Identificador de Pieza, o Idpieza a buscar No se ingresó ninguno de los parámetros para identificar la pieza.
200 Error interno.: 8 - El Numero de Idpieza es Inexistente Parámetro idPieza inexistente
200 Error interno.: 9 - El Identificador de Idpieza es Inexistente Parámetro identificadorPieza inexistente
200 Error interno.: 10 - El Numero de Pieza es inexistente Parámetro numeroPieza inexistente
200 El filler no tiene la estructura correcta, el campo: <campo> es incorrecto. Se ingresó en el filler un campo que no forma parte de su estructura.
200 El filler no tiene la estructura correcta, la cantidad de campos no coinciden para la acción <acción>. Controle. Faltan campos en el filler de la acción indicada.
200 22 - Error no se puede ingresar la Accion en el estado actual de la pieza La pieza tiene un estado y motivo no permitidos para esa acción.
200 21 - La pieza tiene una Accion pendiente, debe anularla si desea accionar La pieza no debe poseer una acción ingresada anteriormente. Se debe cancelar mediante la acción 999.
200 16 - El codigo de Accion es inválido idAccion inexistente.
200 7 - No existe el producto ingresado. producto inexistente.
200 20 - La pieza a Accionar debe ser de tipo Titular o de tipo Paquete Se envió una acción no permitida para el tipo de pieza ingresado.
400 Debe enviar al menos una pieza para ejecutar la acción. El array de acciones está vacío.
400 No puede haber mas de 100 PiezaAccion. Se superó el límite de acciones permitidas por request.

Acciones para las piezas

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.

Descripción
Tipo de acción

Sólo 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
observaciones string

Comentarios adicionales sobre la acción.

Longitud máxima: 100

Ejemplo: "observaciones de llamada"
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
IDEstado Descripción IDMotivo permitido
17 Archivada 1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 136
29 Lógico Recibido 0

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
observaciones string

Comentarios adicionales sobre la acción.

Longitud máxima: 100

Ejemplo: "El timbre no funciona."
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
IDEstado Descripción IDMotivo permitido
8 Programación p/Despacho 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 98
9 A despachar a calle 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 90, 98
10 Visita 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 18, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 90, 98
11 Tramitación Finalizada en Sucursal OCA 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 18, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 98
12 Despachada a planta impositora 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 18, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 90, 98

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
sucursalCliente string Obligatorio

Código de sucursal por parte del cliente.

Longitud máxima: 10

Ejemplo: "000000001"
observaciones string

Comentarios adicionales sobre la acción.

Longitud máxima: 100

Ejemplo: "observaciones de llamada"
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
}
Errores
Código HTTP Mensaje Descripción
200 Error al validar el campo Sucursal Cliente Sucursal de cliente inexistente.
Estados y motivos permitidos
IDEstado Descripción IDMotivo permitido
8 Programación p/Despacho 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 98
9 A Despachar a Calle 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 90, 98
10 Visita 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 18, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 98
11 Tramitación Finalizada en Sucursal Oca 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 18, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 98
12 Despachada a Planta Impositora 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 18, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 90, 98
13 Controlado para Rendir a Cliente 1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69
14 A Archivar 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 90, 136
17 Archivada 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 89, 90, 95, 136
29 Lógico Recibido 0, 183
33 A completar Paquete 0
36 Retenida 0
38 Recepcionada en Sucursal 0
41 Despachada a Sucursal Oca 0
42 Fisico Recibido 0
43 A Enviar a Sucursal Oca 0
44 A Despachar por Recanalización 0
45 En Calle 0
47 Paquete Completo 0
49 Tramitando en Zona Alejada 0, 31
50 Paquete Habilitado 0
62 Repactada a Enviar a Suc. por Acción 0
63 A Reenviar a Sucursal por Acción 0

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
observaciones string

Comentarios adicionales sobre la acción.

Longitud máxima: 100

Ejemplo: "observaciones de llamada"
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
IDEstado Descripción IDMotivo permitido
8 Programación p/Despacho 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 98
9 A Despachar a Calle 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 90, 98
10 Visita 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 18, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 98
11 Tramitación Finalizada en Sucursal Oca 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 18, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 98
12 Despachada a Planta Impositora 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 18, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 90, 98
13 Controlado para Rendir a Cliente 1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69
14 A Archivar 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 90, 136
17 Archivada 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 89, 90, 95, 136
29 Lógico Recibido 0, 183
33 A completar Paquete 0
36 Retenida 0
38 Recepcionada en Sucursal 0
41 Despachada a Sucursal Oca 0
42 Fisico Recibido 0
43 A Enviar a Sucursal Oca 0
44 A Despachar por Recanalización 0
45 En Calle 0
47 Paquete Completo 0
49 Tramitando en Zona Alejada 0, 31
50 Paquete Habilitado 0
62 Repactada a Enviar a Suc. por Acción 0
63 A Reenviar a Sucursal por Acción 0
81 Corrección Operativa 0
88 A Espera en Sucursal 0
90 Devolución Por Acción 0
93 Paquete Liberado 0
202 Recanalizado Electrónicamente 0

Descripción
Tipo de acción

Solo visualizació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
sucursalCliente string Obligatorio

Código de sucursal por parte del cliente.

Longitud máxima: 10

Ejemplo: "000000001"
Acción con filler de ejemplo
{
  "retrocompatibilidad": false,
  "piezasAcciones": [
    {
      "producto": "100575",
      "numeroPieza": "",
      "identificadorPieza": "",
      "idPieza": 251803247,
      "idAccion": 21,
      "filler": {
        "sucursalCliente": "00000000"
      }
    }
  ],
  "cancelaAccionPrevia": true
}
Errores
Código HTTP Mensaje Descripción
200 Error al validar el campo Sucursal Cliente Sucursal de cliente inexistente.
Estados y motivos permitidos
IDEstado Descripción IDMotivo permitido
29 Lógico Recibido 0, 183
33 A completar Paquete 0

Descripción
Tipo de acción

Actualización

Tipo de piezas a accionar

Normal, Paquete

Esta acción se utiliza para que un cliente solicite 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, aquí 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
codigoBanco string Obligatorio

Primeros 3 dígitos de la sucursal cliente.

Longitud máxima: 3

Ejemplo: "000"
sucursalBanco string Obligatorio

Los 7 dígitos restantes de la sucursalCliente.

Longitud máxima: 7

Ejemplo: "0000001"
descripcionBanco string Obligatorio

Nombre del banco.

Longitud máxima: 25

Ejemplo: "Banco Galicia"
descripcionSucursalBanco string Obligatorio

Descripción de sucursal cliente.

Longitud máxima: 25

Ejemplo: "Sucursal Cabildo"
domicilioEntrega string Obligatorio

Domicilio completo de la sucursal. Calle + Nro + Piso + Dpto.

Longitud máxima: 40

Ejemplo: "Av Cabildo 1230"
localidad string Obligatorio

Localidad del nuevo domicilio.

Longitud máxima: 25

Ejemplo: "Capital Federal"
codigoPostal string Obligatorio

Código postal numérico del nuevo domicilio.

Longitud máxima: 8

Ejemplo: "1426"
contacto string Obligatorio

Nombre o cargo de la persona que recibirá la pieza. Luego se verá reflejado en la carta de rendición.

Longitud máxima: 60

Ejemplo: "Portero", "Jose Guevara"
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
IDEstado Descripción IDMotivo permitido
8 Programación p/Despacho 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 98
9 A Despachar a Calle 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 90, 98
10 Visita 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 18, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 98
11 Tramitación Finalizada en Sucursal Oca 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 18, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 98
12 Despachada a Planta Impositora 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 18, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 90, 98
13 Controlado para Rendir a Cliente 1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69
14 A Archivar 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 90, 136
17 Archivada 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 89, 90, 95, 136
29 Lógico Recibido 0
33 A completar Paquete 0
36 Retenida 0
38 Recepcionada en Sucursal 0
41 Despachada a Sucursal Oca 0
42 Fisico Recibido 0
43 A Enviar a Sucursal Oca 0
44 A Despachar por Recanalización 0
45 En Calle 0
47 Paquete Completo 0
50 Paquete Habilitado 0
62 Repactada a Enviar a Suc. por Acción 0
63 A Reenviar a Sucursal por Acción 0
81 Corrección Operativa 0
88 A Espera en Sucursal 0
90 Devolución Por Acción 0
202 Recanalizado Electrónicamente 0

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
Acción con filler de ejemplo
{
  "retrocompatibilidad": false,
  "piezasAcciones": [
    {
      "producto": "100575",
      "numeroPieza": "",
      "identificadorPieza": "",
      "idPieza": 251803247,
      "idAccion": 23,
      "filler": {}
    }
  ],
  "cancelaAccionPrevia": true
}
Estados y motivos permitidos
IDEstado Descripción IDMotivo permitido
16 Rendición enviada al Cliente 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 70, 71, 77, 89, 90, 95, 99, 132, 176, 180
18 Rendida al Cliente 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 70, 71, 77, 89, 90, 95, 99, 132, 176, 180
103 Enviada al Cliente 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 90, 176
104 Entregada en Sucursal del Cliente 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 89, 90

Descripción
Tipo de acción

Actualización

Tipo de piezas a accionar

Normal, Paquete

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

Parámetros
nombre string

Nuevo nombre del destinatario.

Longitud máxima: 20

Ejemplo: "María"
apellido string

Nuevo apellido del destinatario.

Longitud máxima: 30

Ejemplo: "Sanchez"
tipoDocumento string

Nuevo tipo de documento del destinatario.

Longitud máxima: 3

Ejemplo: "DNI"
numeroDocumento string

Nuevo número de documento del destinatario. Colocar números sin espacios.

Longitud máxima: 10

Ejemplo: "20389876549"
telefono string

Nuevo número de teléfono del destinatario.

Longitud máxima: 30

Ejemplo: "4667898"
celular string

Nuevo celular del destinatario.

Longitud máxima: 30

Ejemplo: "1122334455"
mail string

Nuevo email del destinatario.

Longitud máxima: 80

Ejemplo: "sanchez.m@gmail.com"
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
IDEstado Descripción IDMotivo permitido
29 Lógico Recibido 0
42 Fisico Recibido 0

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
Acción con filler de ejemplo
{
  "retrocompatibilidad": false,
  "piezasAcciones": [
    {
      "producto": "100575",
      "numeroPieza": "",
      "identificadorPieza": "",
      "idPieza": 251803247,
      "idAccion": 28,
      "filler": {}
    }
  ],
  "cancelaAccionPrevia": true
}
Estados y motivos permitidos
IDEstado Descripción IDMotivo permitido
15 A Generar Carta de Rendición 18
16 Rendición enviada al Cliente 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 70, 71, 77, 89, 90, 95, 99, 132, 176, 180
18 Rendida al Cliente 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 70, 71, 77, 89, 90, 95, 99, 132, 176, 180
104 Entregada en Sucursal del Cliente 1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 90

Tipo de acción

Actualizació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
Acción con filler de ejemplo
                    
{
  "retrocompatibilidad": false,
  "piezasAcciones": [
    {
      "producto": "100575",
      "numeroPieza": "",
      "identificadorPieza": "",
      "idPieza": 251803247,
      "idAccion": 29,
      "filler": {}
    }
  ],
  "cancelaAccionPrevia": true
}
Estados y motivos permitidos
IDEstado Descripción IDMotivo permitido
15 A Generar Carta de Rendición 18
16 Rendición enviada al Cliente 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 70, 71, 77, 89, 90, 95, 99, 132, 176, 180
18 Rendida al Cliente 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 70, 71, 77, 89, 90, 95, 99, 132, 176, 180

Descripción
Tipo de acción

Sólo 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
observaciones string

Comentarios adicionales sobre la acción.

Longitud máxima: 100

Ejemplo: "observaciones de llamada"
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
IDEstado Descripción IDMotivo permitido
8 Programación p/Despacho 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 70, 77, 89, 90, 95, 98, 182
9 A Despachar a Calle 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 70, 77, 89, 90, 95, 98, 182
10 Visita 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 89, 90, 95, 98
11 Tramitación Finalizada en Sucursal Oca 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25, 26, 30, 31, 33, 40, 51, 52, 58, 59, 64, 69, 89, 90, 95, 98, 182
12 Despachada a Planta Impositora 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25, 26, 30, 31, 33, 40, 51, 52, 58, 59, 64, 69, 89, 90, 95, 98, 182
13 Controlado para Rendir a Cliente 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 70, 89, 90, 95, 180
14 A Archivar 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 19, 20, 21, 23, 24, 25, 26, 30, 31, 33, 40, 51, 52, 58, 59, 64, 69, 89, 90, 95, 136
15 A Generar Carta de Rendición 18
17 Archivada 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 89, 90, 95, 136
19 A generar Manifiesto 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 19, 20, 21, 23, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 89, 90
29 Lógico Recibido 0, 183
33 A completar Paquete 0
34 A Imprimir 0
35 Impresión Realizada 0
36 Retenida 0, 31, 182
38 Recepcionada en Sucursal 0, 31, 182
41 Despachada a Sucursal Oca 0, 31, 137, 182
42 Fisico Recibido 0
43 A Enviar a Sucursal Oca 0, 31, 182
44 A Despachar por Recanalización 0, 31, 181, 182
45 En Calle 0
46 Físico Recibido Masivo 0
47 Paquete Completo 0
49 Tramitando en Zona Alejada 0, 31
50 Paquete Habilitado 0
62 Repactada a Enviar a Suc. por Acción 0
63 A Reenviar a Sucursal por Acción 0
81 Corrección Operativa 0, 31, 182
88 A Espera en Sucursal 0
90 Devolución Por Acción 0
91 Componente Liberado de un Paquete 0
93 Paquete Liberado 0
98 Componente sin paquete 0
100 Carta Generada en Planta Centralizada 0
101 Carta Generada en Planta DesCentralizada 0
103 Enviada al Cliente 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 70, 77, 89, 90, 95, 132, 176, 180
202 Recanalizado Electrónicamente 0

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
productoComponente string Obligatorio

Código de producto del componente.

Longitud máxima: 10

Ejemplo: "PRODTEST", "101234"
vinculoComponente string Obligatorio

Código que vincula el paquete y el componente. Al crear el componente, este mismo valor irá en el parámetro vinculoConPaquete.

Longitud máxima: 20

Ejemplo: "00123"
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
IDEstado Descripción IDMotivo permitido
33 A completar Paquete 0
50 Paquete Habilitado 0

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
productoComponente string Obligatorio

Código de producto del componente.

Longitud máxima: 10

Ejemplo: "PRODTEST", "101234"
vinculoComponente string Obligatorio

Código de vínculo actual del componente.

Longitud máxima: 20

Ejemplo: "00123"
nuevoVinculoComponente string Obligatorio

Nuevo código de vínculo del componente.

Longitud máxima: 20

Ejemplo: "000002"
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
IDEstado Descripción IDMotivo permitido
33 A completar Paquete 0
50 Paquete Habilitado 0

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
productoComponente string Obligatorio

Código de producto del componente.

Longitud máxima: 10

Ejemplo: "PRODTEST", "101234"
vinculoComponente string Obligatorio

Código de vínculo del componente.

Longitud máxima: 20

Ejemplo: "00123"
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
IDEstado Descripción IDMotivo permitido
33 A completar Paquete 0
50 Paquete Habilitado 0

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
observaciones string

Comentarios adicionales sobre la acción.

Longitud máxima: 50

Ejemplo: "El timbre no funciona."
Acción con filler de ejemplo
{
  "retrocompatibilidad": false,
  "piezasAcciones": [
    {
      "producto": "100575",
      "numeroPieza": "",
      "identificadorPieza": "",
      "idPieza": 251803247,
      "idAccion": 36,
      "filler": {
        "observaciones": "El timbre no funciona."
      }
    }
  ],
  "cancelaAccionPrevia": true
}
Estados y motivos permitidos
IDEstado Descripción IDMotivo permitido
17 Archivada 23
29 Lógico Recibido 0
33 A completar Paquete 0
42 Fisico Recibido 0
43 A Enviar a Sucursal Oca 0, 182
47 Paquete Completo 0
50 Paquete Habilitado 0
63 A Reenviar a Sucursal por Acción 0
90 Devolución Por Acción 0
93 Paquete Liberado 0

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
productoComponente string Obligatorio

Código de producto del componente.

Longitud máxima: 10

Ejemplo: "PRODTEST", "101234"
vinculoComponente string Obligatorio

Código de vínculo del componente.

Longitud máxima: 20

Ejemplo: "00123"
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
IDEstado Descripción IDMotivo permitido
33 A completar Paquete 0
50 Paquete Habilitado 0

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
Acción con filler de ejemplo
{
  "retrocompatibilidad": false,
  "piezasAcciones": [
    {
      "producto": "100575",
      "numeroPieza": "",
      "identificadorPieza": "",
      "idPieza": 251803247,
      "idAccion": 48,
      "filler": {}
    }
  ],
  "cancelaAccionPrevia": true
}
Estados y motivos permitidos
IDEstado Descripción IDMotivo permitido
29 Lógico Recibido 0, 183
33 A completar Paquete 0

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
sucursalOca string Obligatorio

Siglas de la sucursal de OCA.

Longitud máxima: 3

Ejemplo: "PIA"
personasAutorizadas string

Nombre de la persona autorizada a retirar la pieza. Puede ser más de una.

Longitud máxima: 60

Ejemplo: "Diego Lopez, Juan Perez"
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
IDEstado Descripción IDMotivo permitido
8 Programación p/Despacho 0, 55, 95
9 A Despachar a Calle 0, 95
10 Visita 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 95
11 Tramitación Finalizada en Sucursal Oca 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 95
12 Despachada a Planta Impositora 2
14 A Archivar 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 19, 20, 21, 23, 24, 25, 26, 30, 31, 33, 40, 51, 52, 58, 59, 64, 69, 89, 90, 95, 136
17 Archivada 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 19, 20, 21, 23, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 95, 136
29 Lógico Recibido 0, 183
33 A completar Paquete 0
36 Retenida 0, 31, 182
38 Recepcionada en Sucursal 0
41 Despachada a Sucursal Oca 0
42 Fisico Recibido 0
43 A Enviar a Sucursal Oca 0
45 En Calle 0
46 Físico Recibido Masivo 0
47 Paquete Completo 0
50 Paquete Habilitado 0
88 A Espera en Sucursal 0, 55
93 Paquete Liberado 0

Descripción
Tipo de acción

Actualización

Tipo de piezas a accionar

Normal

Se utiliza para casos donde las piezas físicas sean innominadas 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.

Parámetros
observaciones string

Comentarios adicionales sobre la acción.

Longitud máxima: 100

Ejemplo: "No retira"
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
IDEstado Descripción IDMotivo permitido
17 Archivada 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 71, 89, 90, 95, 136
18 Rendida al Cliente 18, 132

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
lunes string

Día de la semana en que puede realizarse la entrega. Marcar con "X" si corresponde.

Longitud máxima: 1

Ejemplo: "X"
martes string

Día de la semana en que puede realizarse la entrega. Marcar con "X" si corresponde.

Longitud máxima: 1

Ejemplo: "X"
miercoles string

Día de la semana en que puede realizarse la entrega. Marcar con "X" si corresponde.

Longitud máxima: 1

Ejemplo: "X"
jueves string

Día de la semana en que puede realizarse la entrega. Marcar con "X" si corresponde.

Longitud máxima: 1

Ejemplo: "X"
viernes string

Día de la semana en que puede realizarse la entrega. Marcar con "X" si corresponde.

Longitud máxima: 1

Ejemplo: "X"
sabado string

Día de la semana en que puede realizarse la entrega. Marcar con "X" si corresponde.

Longitud máxima: 1

Ejemplo: "X"
horaDesde string Obligatorio

Hora a partir de la cual puede visitarse el domicilio de destino. Utilizar formato HH:MM.

Longitud máxima: 5

Ejemplo: "10:00"
horaHasta string Obligatorio

Hora límite para visitar el domicilio de destino. Utilizar formato HH:MM.

Longitud máxima: 5

Ejemplo: "18:00"
observaciones string

Comentarios adicionales sobre la acción.

Longitud máxima: 100

Ejemplo: "No retira"
fechaPactadaVisita date

Fecha en la cual debe realizarse la entrega. Utilizar formato DD/MM/YYYY.

Longitud máxima: 10

Ejemplo: "20/11/2024"
semanaaVisitarComienza date

Fecha de la semana a partir de la cual se realizarán las visitas.

Longitud máxima: 10

Ejemplo: "20/11/2024"
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
IDEstado Descripción IDMotivo permitido
8 Programación p/Despacho 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 19, 20, 21, 23, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 95, 98
9 A Despachar a Calle 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 19, 20, 21, 23, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 90, 95, 98
10 Visita 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 19, 20, 21, 23, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 95, 98
11 Tramitación Finalizada en Sucursal Oca 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 95, 98
12 Despachada a Planta Impositora 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 95, 98
13 Controlado para Rendir a Cliente 1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69
14 A Archivar 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 90, 95, 136
15 A Generar Carta de Rendición 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 90
17 Archivada 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 90, 95, 136
29 Lógico Recibido 0
33 A completar Paquete 0
36 Retenida 0
38 Recepcionada en Sucursal 0
41 Despachada a Sucursal Oca 0
42 Fisico Recibido 0
43 A Enviar a Sucursal Oca 0
44 A Despachar por Recanalización 0
45 En Calle 0
47 Paquete Completo 0
49 Tramitando en Zona Alejada 0, 31
50 Paquete Habilitado 0
62 Repactada a Enviar a Suc. por Acción 0
63 A Reenviar a Sucursal por Acción 0
81 Corrección Operativa 0
88 A Espera en Sucursal 0
93 Paquete Liberado 0
202 Recanalizado Electrónicamente 0

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
calle string Obligatorio

Calle del nuevo domicilio. Puede enviarse Calle + Nro + Piso + Dpto y omitir los demás campos.

Longitud máxima: 50

Ejemplo: "Entre Rios"
numero string

Número del nuevo domicilio.

Longitud máxima: 5

Ejemplo: "2061"
torre string

Torre del nuevo domicilio.

Longitud máxima: 1

Ejemplo: "1"
piso string

Piso del nuevo domicilio.

Longitud máxima: 2

Ejemplo: "4"
departamento string

Letra o número de departamento.

Longitud máxima: 4

Ejemplo: "A"
localidad string Obligatorio

Localidad del nuevo domicilio.

Longitud máxima: 35

Ejemplo: "Córdoba"
provincia string Obligatorio

Provincia del nuevo domicilio.

Longitud máxima: 25

Ejemplo: "Córdoba"
codigoPostal string

Código postal numérico del nuevo domicilio.

Longitud máxima: 8

Ejemplo: "5010"
pais string

País del nuevo domicilio.

Longitud máxima: 30

Ejemplo: "Argentina"
telefono string

Teléfono celular preferentemente.

Longitud máxima: 30

Ejemplo: "1100363765"
lunes string

Marcar con "X".

Máx.: 1

Ej.: "X"
martes string

Marcar con "X".

Máx.: 1

Ej.: "X"
miercoles string

Marcar con "X".

Máx.: 1

Ej.: "X"
jueves string

Marcar con "X".

Máx.: 1

Ej.: "X"
viernes string

Marcar con "X".

Máx.: 1

Ej.: "X"
sabado string

Marcar con "X".

Máx.: 1

Ej.: "X"
horaDesde string Obligatorio

Hora desde la cual puede visitarse el domicilio. Formato HH:MM.

Longitud máxima: 5

Ejemplo: "10:00"
horaHasta string Obligatorio

Hora límite para visitar el domicilio. Formato HH:MM.

Longitud máxima: 5

Ejemplo: "18:00"
observaciones string

Comentarios adicionales sobre la acción.

Longitud máxima: 100

Ejemplo: "No retira"
fechaPactadaVisita date

Fecha en la cual debe realizarse la entrega. Formato DD/MM/YYYY.

Longitud máxima: 10

Ejemplo: "20/11/2024"
semanaaVisitarComienza date

Fecha de la semana a partir de la cual se realizarán las visitas.

Longitud máxima: 10

Ejemplo: "20/11/2024"
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
}
Errores
Código HTTP Mensaje Descripción
200 Error al validar el campo Codigo Postal Código postal inexistente.
Estados y motivos permitidos
IDEstado Descripción IDMotivo permitido
8 Programación p/Despacho 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 19, 20, 21, 23, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 95, 98
9 A Despachar a Calle 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 19, 20, 21, 23, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 90, 95, 98
10 Visita 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 19, 20, 21, 23, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 95, 98
11 Tramitación Finalizada en Sucursal Oca 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 95, 98
12 Despachada a Planta Impositora 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 90, 95, 98
13 Controlado para Rendir a Cliente 1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 19, 20, 21, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69
14 A Archivar 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 19, 20, 21, 23, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 90, 95, 136
17 Archivada 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25, 26, 30, 33, 40, 51, 52, 58, 59, 64, 69, 90, 95, 136
29 Lógico Recibido 0
33 A completar Paquete 0
36 Retenida 0
38 Recepcionada en Sucursal 0
41 Despachada a Sucursal Oca 0
42 Fisico Recibido 0
43 A Enviar a Sucursal Oca 0
44 A Despachar por Recanalización 0
45 En Calle 0
47 Paquete Completo 0
49 Tramitando en Zona Alejada 0, 31
50 Paquete Habilitado 0
62 Repactada a Enviar a Suc. por Acción 0
63 A Reenviar a Sucursal por Acción 0
81 Corrección Operativa 0
88 A Espera en Sucursal 0
90 Devolución Por Acción 0
93 Paquete Liberado 0
202 Recanalizado Electrónicamente 0

Descripción
Tipo de acción

Actualización

Tipo de piezas a accionar

Paquete

Esta acción se utiliza en caso de querer forzar a un paquete incompleto (a la espera de componentes físicos) a salir a distribución. El paquete se liberará con aquellos componentes físicos que tenga cargados en el momento.

Los componentes lógicos (sin pieza física) se convertirán en piezas comunes (tipo 1).

Parámetros
Acción con filler de ejemplo
{
  "retrocompatibilidad": false,
  "piezasAcciones": [
    {
      "producto": "100575",
      "numeroPieza": "",
      "identificadorPieza": "",
      "idPieza": 251803247,
      "idAccion": 93,
      "filler": {}
    }
  ],
  "cancelaAccionPrevia": true
}
Estados y motivos permitidos
IDEstado Descripción IDMotivo permitido
50 Paquete Habilitado 0

Descripción
Tipo de acción

Cancelar

Tipo de piezas a accionar

Todas

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

Parámetros
observaciones string

Comentarios adicionales sobre la acción.

Longitud máxima: 100

Ejemplo: "Observaciones"
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
IDEstado Descripción IDMotivo permitido
29 Lógico Recibido 0
33 A completar Paquete 0
36 Retenida 0
38 Recepcionada en Sucursal 0
41 Despachada a Sucursal Oca 0
42 Fisico Recibido 0
43 A Enviar a Sucursal Oca 0
44 A Despachar por Recanalización 0
45 En Calle 0
47 Paquete Completo 0
49 Tramitando en Zona Alejada 0, 31
50 Paquete Habilitado 0
62 Repactada a Enviar a Suc. por Acción 0
63 A Reenviar a Sucursal por Acción 0
81 Corrección Operativa 0
88 A Espera en Sucursal 0
93 Paquete Liberado 0
202 Recanalizado Electrónicamente 0

Obtener acuse de pieza por número

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

Entorno URL
Test https://test.oca.com.ar/ApiPostal/OCAGEOApiController/GetAcuseByNumeroPieza
Producción https://www1.oca.com.ar/ApiPostal/OCAGEOApiController/GetAcuseByNumeroPieza

Parámetros

numeroPieza string Obligatorio

Número de la pieza asignado por parte del cliente.

Ejemplo: "F0123456"
devolverUrl boolean

Parámetro para determinar la forma en la que se obtiene el acuse. Si se ingresa false se obtiene un PDF en formato base64; si se ingresa true devuelve una URL. Por defecto se obtiene la URL.

Ejemplo: true

Request

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

Response

Ejemplo de respuesta exitosa

Status: 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="
}

Errores

Ejemplos de response con errores

Status: 200 OK 
{
  "success": false,
  "message": "Error interno.: No se encontró la pieza: 12345",
  "result": ""
}
Código HTTP Mensaje Descripción
200 Error interno.: No se encontró la pieza: 12345 Pieza inexistente.
200 Error interno.: No existe el Acuse de la Pieza solicitada. La pieza existe, pero no tiene acuse.

Obtener acuse de pieza por ID

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

Entorno URL
Test https://test.oca.com.ar/ApiPostal/OCAGEOApiController/GetAcuseByIdPieza
Producción https://www1.oca.com.ar/ApiPostal/OCAGEOApiController/GetAcuseByIdPieza

Parámetros

idPieza string Obligatorio

Identificador único de la pieza en la base de datos.

Ejemplo: "123456"
devolverUrl boolean

Parámetro para determinar la forma en la que se obtiene el acuse. Si se ingresa false se obtiene un PDF en formato base64; si se ingresa true devuelve una URL. Por defecto se obtiene la URL.

Ejemplo: true

Request

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

Response

Ejemplo de respuesta exitosa

Status: 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="
}

Errores

Ejemplos de response con errores

Status: 200 OK 
{
  "success": false,
  "message": "Error interno.: No se encontró la pieza: 12345",
  "result": ""
}
Código HTTP Mensaje Descripción
200 Error interno.: No se encontró la pieza: 12345 Pieza inexistente.
200 Error interno.: No existe el Acuse de la Pieza solicitada. La pieza existe, pero no tiene acuse.

Obtener acuses de múltiples piezas

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

Entorno URL
Test https://test.oca.com.ar/ApiPostal/OCAGEOApiController/GetAcusesByNumeroPieza
Producción https://www1.oca.com.ar/ApiPostal/OCAGEOApiController/GetAcusesByNumeroPieza

Parámetros

devolverUrl boolean

Parámetro para determinar la forma en la que se obtiene el acuse. Si se ingresa false se obtiene un PDF en formato base64; si se ingresa true devuelve una URL. Por defecto se obtiene la URL.

Ejemplo: true

Request body

numerosPiezas Array<string> Obligatorio

Array de strings que contiene los distintos números de pieza a consultar.

Ejemplo: ["12345", "6789"]

Request

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

Response

Ejemplo de respuesta exitosa

Status: 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=132498064&op=0&clase=ACUSES&rdp=&cli=BCD&fecha=\"}]"
}

Errores

Ejemplos de response con errores

Status: 200 OK 
{
  "success": true,
  "message": "Success",
  "result": "[{\"success\":false,\"message\":\"Error interno.: No se encontró la pieza: 12345\",\"result\":\"\"},{\"success\":false,\"message\":\"Error interno.: No se encontró la pieza: 6789\",\"result\":\"\"}]"
}
Código HTTP Mensaje Descripción
200 Error interno.: Parametro en input numerosPiezas null! Array de piezas vacío.
200 Error interno.: No se encontró la pieza: 12345 Pieza inexistente.
200 Error interno.: No existe el Acuse de la Pieza solicitada. La pieza existe, pero no tiene acuse.

Flujos de ejemplo

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

Datos de prueba

En esta sección se presentan datos genéricos que pueden utilizarse en el entorno de test con el objetivo de familiarizarse con la API y validar su funcionamiento básico. Estos datos están diseñados para facilitar los primeros pasos en el proceso de integración.

Para avanzar hacia una integración completa en el entorno productivo, es necesario solicitar credenciales exclusivas escribiendo a: integraciones@oca.com.ar.

Para más información sobre los diferentes roles de usuario, configuraciones previas necesarias y cómo obtener accesos, consultar la sección Login, accesos y permisos.

Credenciales

Cliente Usuario Contraseña Perfil
TEST OCA_APIGEO v3Nc@K-a OCAGEO - Administrador

Operativas y productos

Operativa Descripción operativa Producto Descripción Para paquetes
OPTEST Operativa Test PRODTEST Producto Test No
OPTEST Operativa Test PAQTEST1 Paquete Test Si
OPTEST Operativa Test COMPOTEST1 Componente Test No

Sucursales de ejemplo (para cliente)

Código de sucursal Descripción Domicilio CP Localidad
0000000000 Casa central Riobamba 1234 6 A 1116 Capital Federal
0000000001 Centro Florida 99 1000 Capital Federal

Piezas de ejemplo

Pieza de prueba
Nombre y apellido

Rodrigo Lopez

idPieza

251889515

numeroPieza

0000001

Operativa

OPTEST

Producto

PRODTEST

Tipo y número de documento

DNI 39123456

Fecha de alta

04/12/2024