Modificar Devoluciones

Permite modificar los campos reference (referencia del documento en el ERP) y last_erp_state (último estado reportado por el ERP) de una o múltiples devoluciones mediante una única petición. Este endpoint está diseñado para operaciones de modificación en lote (batch), permitiendo procesar hasta 10,000 registros por petición.

Método: PATCH

Endpoint

https://api.ventasremotas.com/v1/returns/batch-update

Encabezados de la solicitud

Header	Valor	Descripción
`Content-Type`	`application/json`	Indica que los datos se envían en formato JSON
`Accept`	`application/json`	Indica que la respuesta debe estar en formato JSON
`Subscription-Key`	`{subscription_key}`	Clave de suscripción para acceder a la API
`Authorization`	`Bearer {access_token}`	Token de acceso obtenido del endpoint `/token`

Parámetros del Cuerpo (Body)

El body debe ser un array de objetos, donde cada objeto representa una devolución a modificar.

Límites

Parámetro	Valor	Descripción
Mínimo de items	1	El array no puede estar vacío
Máximo de items	10,000	Número máximo de devoluciones por petición

Campos

El cuerpo (Body) de la solicitud debe enviarse en formato JSON y debe incluir un array con los siguientes parámetros.

Campo	Tipo	Nulo	Restricciones	Descripción
`code`	string (max 30)	No	Requerido	Código de la devolución a modificar
`reference`	string (max 20)	Sí	Opcional	Referencia del documento en el sistema ERP. Si se omite, no se modifica
`last_erp_state`	string (max 250)	Sí	Opcional	Último estado de la devolución reportado por el ERP. Si se omite, no se modifica

Formato de tipos de dato

string (max N): Cadena de texto con longitud máxima de N caracteres.

Ejemplo de Solicitud

Modificar solo la referencia ERP de una devolución:

[
  {
    "code": "DEV-20250301-001",
    "reference": "REF-ERP-00123"
  }
]

Modificar solo el estado ERP:

[
  {
    "code": "DEV-20250301-001",
    "last_erp_state": "PROCESADO"
  }
]

Modificar ambos campos en varias devoluciones (batch):

[
  {
    "code": "DEV-20250301-001",
    "reference": "REF-ERP-00123",
    "last_erp_state": "PROCESADO"
  },
  {
    "code": "DEV-20250228-003",
    "last_erp_state": "PROCESADO"
  }
]

Ejemplo de Respuesta

{
    "statusCode": 200,
    "message": "Returns updated successfully"
}

{
    "statusCode": 400,
    "errors": [
        {
            "message": "Invalid JSON in request body"
        }
    ]
}

{
    "statusCode": 415,
    "errors": [
        {
            "message": "Content-Type: application/json is required"
        }
    ]
}

Errores globales (estructura del body)

Si el body no es un array:

{
    "statusCode": 422,
    "errors": [
        {
            "message": "Request body must be an array"
        }
    ]
}

Si el array está vacío:

{
    "statusCode": 422,
    "errors": [
        {
            "message": "Request body cannot be empty"
        }
    ]
}

Si excede el límite de 10,000 items:

{
    "statusCode": 422,
    "errors": [
        {
            "message": "Array exceeds maximum limit of 10000 items"
        }
    ]
}

Errores por item (validación de campos)

Los errores se agrupan por el índice del item en el array:

{
    "statusCode": 422,
    "errors": [
        {
            "index": 0,
            "errors": [
                {
                    "field": "code",
                    "message": "Field is required"
                }
            ]
        },
        {
            "index": 2,
            "errors": [
                {
                    "field": "reference",
                    "message": "Field exceeds maximum length of 20 characters"
                }
            ]
        }
    ]
}

Tipos de Errores de Validación por Campo

Errores de presencia y nulidad:

Error	Descripción
`Field is required`	El campo no fue enviado en el objeto (la clave no existe)
`Field cannot be null or empty`	El campo fue enviado con valor `null` o vacío y no acepta nulos
`Unknown field`	Se envió un campo que no existe en la configuración
`Item must be an object`	Un elemento del array no es un objeto JSON

Errores de tipo de dato:

Error	Descripción
`Field must be a string`	El valor no es una cadena de texto

Errores de longitud:

Error	Campo	Descripción
`Field exceeds maximum length of 30 characters`	`code`	La cadena excede la longitud máxima permitida
`Field exceeds maximum length of 20 characters`	`reference`	La cadena excede la longitud máxima permitida
`Field exceeds maximum length of 250 characters`	`last_erp_state`	La cadena excede la longitud máxima permitida

{
    "statusCode": 423,
    "errors": [
        {
            "message": "Resource is locked and cannot be accessed."
        }
    ]
}

Error de conexión a base de datos

{
    "statusCode": 500,
    "errors": [
        {
            "message": "Error connecting to database"
        }
    ]
}

Error de operación en base de datos

{
    "statusCode": 500,
    "errors": [
        {
            "message": "Database operation failed"
        }
    ]
}

Error en Redis

{
    "statusCode": 500,
    "errors": [
        {
            "message": "Redis operation failed"
        }
    ]
}

Error en validaciones

{
    "statusCode": 500,
    "errors": [
        {
            "message": "Unexpected error in the validations"
        }
    ]
}

Error inesperado

{
    "statusCode": 500,
    "errors": [
        {
            "message": "Unexpected error"
        }
    ]
}

Error del Servidor

Estos errores indican problemas internos en el servidor, la base de datos o el servicio de cache. Si persisten, contacta al equipo de soporte.