Criar unidade operacional

Este endpoint permite criar uma unidade operacional na empresa. Apenas name e externalCode são obrigatórios.


Rota: POST /os/v1/operation-units

Campos obrigatórios

  • name: Nome. Máximo de 300 caracteres.
  • externalCode: Código externo. Máximo de 50 caracteres. Deve ser único na empresa.

Campos opcionais

  • address: Endereço. Máximo de 600 caracteres.
  • businessRegistrationNumber: CNPJ da unidade (14 dígitos ou formato 00.000.000/0000-00).
  • externalCodeParent: Código externo da unidade operacional pai (hierarquia).

Resposta de sucesso (201)

Retorna result com uuid, name, externalCode, address, businessRegistrationNumber e dados do pai quando aplicável.

Exemplo de requisição (cURL)

curl --request POST \
     --url 'https://api.gupy.io/os/v1/operation-units' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer bearer_token_value_here' \
     --data '{
       "name": "Matriz São Paulo",
       "externalCode": "SP-001",
       "address": "Av. Paulista, 1000",
       "businessRegistrationNumber": "96925786000127",
       "externalCodeParent": "ROOT-001"
     }'

Atenção: Forneça o token no cabeçalho Authorization.

Possíveis erros

Não autenticado (401)

{
  "statusCode": 401,
  "message": "Unauthorized"
}

Erro interno (500)

{
  "statusCode": 500,
  "message": "Unexpected error occurred"
}