Pular para o conteúdo principal

Adicionar uma etiqueta à ordem

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

Adiciona à ordem de serviço uma etiqueta do tipo ordens de serviço. Retorna a etiqueta.

Requer os headers X-Api-Key, User-Agent e Content-Type: application/json. Limite: 1 requisição por segundo (saiba mais).

Requisição​

Parâmetros de caminho

idstringobrigatório

Identificador da ordem de serviço.

Exemplo: NDJiMWQ0YzQtOWNmOC00NWE2LTg2MjItYjNjNzZjZjk0MmM4OjIyOTE1.

Headers

User-Agentstringobrigatório

Identificação da sua aplicação.

Exemplo: MinhaIntegracao/1.0.

Corpo da requisição

JSON, enviado com o header Content-Type: application/json.

labelobjectobrigatório
Campos de label
idstringobrigatório

Identificador de uma etiqueta de ordens de serviço da conta.

Respostas

  • 201

    Etiqueta adicionada.

  • 401

    Chave de API ausente (Missing API Key) ou inválida (Invalid API Key). Ver Autenticação.

  • 403

    Conta bloqueada (Account blocked), expirada (Account expired) ou com plano que não permite integração (Account plan not allowed). Ver Autenticação.

  • 404

    Recurso não encontrado. O corpo da resposta é vazio.

  • 409

    Etiqueta já adicionada à ordem (resourceAlreadyExists).

  • 422

    Etiqueta inexistente, de outro tipo (message: label is not order label) ou identificador inválido (resourceValidationErr). Identificador da ordem inválido: uriValidationErr.

  • 429

    Limite de 1 requisição por segundo excedido. Ver Limite de requisições.

  • 500

    Erro inesperado no servidor.