Saltar al contenido principal

Agregar un producto a la orden

POSThttps://carchost.fieldcontrol.com.br/orders/{id}/products-v2

Agrega un producto a la orden de servicio y recalcula los totales. En cuentas con el módulo de control de inventario, retira el producto del depósito informado. Una orden acepta hasta 150 productos.

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 orden de servicio.

Ejemplo: NDJiMWQ0YzQtOWNmOC00NWE2LTg2MjItYjNjNzZjZjk0MmM4OjIyOTE1.

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.

productobjectobligatorio
Campos de product
idstringobligatorio

Identificador del producto.

quantitynumberobligatorio

Cantidad.

valuenumber o string

Valor unitario. Si se omite, se usa el valor del producto; null guarda 0. En cuentas con el módulo de control de inventario, siempre es el valor del producto.

Acepta: null.

storageobject

Depósito del que sale el producto. Obligatorio en cuentas con el módulo de control de inventario: la API registra un movimiento de salida y rechaza cantidades mayores que el saldo.

Campos de storage
idstringobligatorio
descriptionstring

Descripción guardada en el movimiento de inventario.

Respuestas

  • 201

    Producto agregado.

  • 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.

  • 404

    Recurso no encontrado. El cuerpo de la respuesta está vacío.

  • 422

    Cuerpo inválido (resourceValidationErr): producto inexistente, ya agregado (reason: already exists), límite de 150 productos o, con control de inventario, depósito ausente, producto sin saldo en el depósito o cantidad mayor que el saldo (reason: not enough). Identificador de la orden inválido: uriValidationErr.

  • 429

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

  • 500

    Error inesperado en el servidor.