Saltar al contenido principal

Crear una pieza

POSThttps://carchost.fieldcontrol.com.br/parts

Crea una pieza, ya con los tipos de equipo en los que se puede instalar y los campos personalizados.

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

Solicitud​

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.

namestringobligatorio

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

codestringobligatorio

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

partTypeIdstringobligatorio

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.Predeterminado: new.

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

Identificadores de los tipos de equipo en los que se puede instalar la pieza. Solo se considera en la creación.

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

  • 201

    Pieza creada.

  • 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 (resourceValidationErr): name, code o partTypeId ausentes (reason: missing required field), name o code ya usados en la cuenta (reason: duplicate), tipo de pieza inexistente o usageCondition inválida.

  • 429

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

  • 500

    Error inesperado en el servidor.