Saltar al contenido principal

Agregar una etiqueta a la orden

POSThttps://carchost.fieldcontrol.com.br/orders/{id}/labels

Agrega a la orden de servicio una etiqueta del tipo órdenes de servicio. Devuelve la etiqueta.

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.

labelobjectobligatorio
Campos de label
idstringobligatorio

Identificador de una etiqueta de órdenes de servicio de la cuenta.

Respuestas

  • 201

    Etiqueta agregada.

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

  • 409

    Etiqueta ya agregada a la orden (resourceAlreadyExists).

  • 422

    Etiqueta inexistente, de otro tipo (message: label is not order label) o identificador inválido (resourceValidationErr). 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.