Saltar al contenido principal

Crear un producto

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

Crea un producto.

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 del producto.

Hasta 100 caracteres.

descriptionstring

Descripción del producto.

Hasta 2000 caracteres.

codestringobligatorio

Código del producto. Debe ser único entre los productos de la cuenta.

measurestringobligatorio

Unidad de medida. Los valores fuera de esta lista se guardan como unity. kilogram se guarda, pero vuelve como null en las respuestas.

Valores aceptados: unity, centimeter, meter, liter, milliliter, kilogram.

valuenumberobligatorio

Valor unitario del producto.

archivedbooleanobligatorio

Archiva el producto.

externalobject
Campos de external
idstring

Identificador del producto en su sistema.

Hasta 100 caracteres.Acepta: null.

productTypeobjectobligatorio

Tipo del producto, por id o por name. Con name, la API usa el primer tipo de la cuenta cuyo nombre contiene el texto informado, sin distinguir mayúsculas y minúsculas.

Campos de productType
idstring

Identificador del tipo de producto.

namestring

Nombre (o parte del nombre) del tipo de producto.

Respuestas

  • 201

    Producto creado.

  • 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), code ya usado por otro producto de la cuenta (message: product code already exists) o productType sin id ni name.

  • 429

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

  • 500

    Error inesperado en el servidor. También ocurre cuando no se envía productType.