Saltar al contenido principal

Actualizar una pieza

PUThttps://carchost.fieldcontrol.com.br/parts/{id}

Actualiza una pieza. Envíe solo los campos que van a cambiar. Los tipos de equipo se modifican mediante los endpoints propios.

Requiere los headers X-Api-Key, User-Agent y Content-Type: application/json. Límite: 1 solicitud por segundo (más información).

Solicitud​

Parámetros de ruta

idstringobligatorio

Identificador de la pieza.

Ejemplo: YjJjM2Q0ZTUtZjZhNy04OTAxLWJjZGUtZjEyMzQ1Njc4OTAxOjIyOTE1.

Headers

User-Agentstringobligatorio

Identificación de su aplicación.

Ejemplo: MinhaIntegracao/1.0.

Cuerpo de la solicitud

JSON, enviado con el header Content-Type: application/json.

namestring

Nombre de la pieza. Debe ser único en la cuenta.

codestring

Código de la pieza. Debe ser único en la cuenta.

partTypeIdstring

Identificador del tipo de pieza.

descriptionstring

Descripción de la pieza.

imageUrlstring

URL de la imagen de la pieza.

usageConditionstring

Condición de uso.

Valores aceptados: new, semi_new, used, refurbished, defective.

valuenumber

Valor unitario.

externalIdstring

Identificador de la pieza en su sistema.

archivedboolean

Archiva la pieza.

minimalQuantitynumber

Cantidad mínima en inventario. No puede ser negativa.

minimalQuantityAtRisknumber

Cantidad a partir de la cual el inventario se considera en riesgo. No puede ser negativa.

equipmentTypeIdslista de string

Se ignora en la actualización. Use los endpoints de tipos de equipo de la pieza.

customFieldslista de objetos

Campos personalizados. Cuando se envía, reemplaza todos los campos actuales.

Campos de customFields
namestring

Nombre del campo.

valuestring

Valor del campo.

typestringobligatorio

Tipo del campo. Ausente o fuera de esta lista resulta en error 500 y no se guarda nada.

Valores aceptados: question, multiple-choice, date, number.

positioninteger

Posición de visualización. El valor predeterminado es el orden en el array, a partir de 1.

Respuestas

  • 200

    Pieza actualizada.

  • 401

    Clave de API ausente (Missing API Key) o inválida (Invalid API Key). Consulte Autenticación.

  • 403

    Cuenta bloqueada (Account blocked), vencida (Account expired) o con un plan que no permite integración (Account plan not allowed). Consulte Autenticación.

  • 422

    Cuerpo inválido, con las mismas reglas de la creación (resourceValidationErr); cantidad mínima negativa; identificador de la URL inválido (property: @.id). Pieza inexistente: 422 resourceNotFound (no hay 404). Identificador inválido o de otra cuenta: uriValidationErr.

  • 429

    Se superó el límite de 1 solicitud por segundo. Consulte Límite de solicitudes.

  • 500

    Error inesperado en el servidor.