Saltar al contenido principal

Crear un producto o servicio

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

Crea un producto o un servicio, según type. En cuentas con el módulo de control de inventario, un producto se puede crear ya con saldo en los inventarios (storageProducts).

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 o servicio.

Hasta 100 caracteres.

typestring o numberobligatorio

product o service. Un número u otro texto resulta en error 500.

Valores aceptados: product, service.

descriptionstring

Descripción.

Hasta 2000 caracteres.

measurestringobligatorio

Unidad de medida, obligatoria también para servicios. 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.

archivedbooleanobligatorio

Archiva el producto o servicio.

externalobject
Campos de external
idstring

Identificador en su sistema.

Hasta 100 caracteres.Acepta: null.

storageProductslista de objetos

Saldo inicial en cada inventario. Solo se considera en la creación de productos (type: product) en cuentas con el módulo de control de inventario: la API registra un movimiento de entrada por ítem. Se ignora en la actualización.

Campos de storageProducts
storageobjectobligatorio
Campos de storage
idstringobligatorio

Identificador del inventario.

quantitynumberobligatorio

Cantidad de entrada.

minimalQuantitynumber

Cantidad mínima del producto en el inventario.

Acepta: null.

minimalQuantityAtRisknumber

Cantidad a partir de la cual el inventario se considera en riesgo.

Acepta: null.

Respuestas

  • 201

    Producto o servicio 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).

  • 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 type no es product ni service.