Saltar al contenido principal
Crear una Organización
curl --request POST \
  --url http://127.0.0.1:3000/v1/organizations \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "legalName": "Grupo Hessel S.A.",
  "doingBusinessAs": "Hessel Comercio Internacional",
  "legalDocument": "22367046391413",
  "status": {
    "code": "ACTIVE",
    "description": "Organización activa y operativa"
  },
  "address": {
    "line1": "Av. Libertador 1289",
    "line2": "Piso 12, Oficina 1204",
    "zipCode": "1001",
    "city": "Buenos Aires",
    "state": "Buenos Aires",
    "country": "AR"
  },
  "metadata": {
    "industry": "Comercio Exterior",
    "internalCode": "INT-HSL-001",
    "notes": "Registro inicial de la organización"
  }
}
'
{
  "id": "cc15194a-6bc9-4ebb-b15d-43411a54ba4b",
  "parentOrganizationId": null,
  "legalName": "Empresa Teste Ltda",
  "doingBusinessAs": "Empresa Teste",
  "legalDocument": "86820799000188",
  "address": {
    "line1": "Rua Botucatu, 10",
    "line2": "Casa B",
    "zipCode": "04023060",
    "city": "São Paulo",
    "state": "SP",
    "country": "BR"
  },
  "status": {
    "code": "ACTIVE",
    "description": null
  },
  "createdAt": "2024-02-08T16:59:31+0300",
  "updatedAt": "2024-02-08T16:59:31+0300",
  "deletedAt": null
}

Encabezados

​
Content-Type
string
requerido

Tipo de medio del recurso. Debe ser application/json.

​
Authorization
string

Token de autorización. Este encabezado es obligatorio si tu entorno tiene habilitado el Access Manager.

​
X-Request-Id
string

Identificador único usado para rastrear y seguir cada solicitud.

Cuerpo

application/json
​
legalName
string
requerido

Nombre legal de la organización.

Maximum string length: 256
​
legalDocument
string
requerido

Documento legal de la organización.

Maximum string length: 256
​
address
object
requerido

Objeto que contiene información sobre la dirección de la organización.

​
parentOrganizationId
string<uuid> | null

Identificador único de la organización matriz.

​
doingBusinessAs
string | null

Nombre comercial de la organización.

Maximum string length: 256
​
status
object

Objeto que contiene información sobre el estado. Importante: Si no se proporciona, el estado predeterminado será 'ACTIVE'.

​
metadata
object

Objeto que contiene pares clave-valor para agregar como metadatos, donde el campo name es la clave y el campo value es el valor. Por ejemplo, para agregar un centro de costos, usa 'costCenter': 'BR_11101997'.

Respuesta

Indica que el recurso se creó correctamente y que la operación se completó según lo esperado.

​
id
string<uuid>

Identificador único de la organización.

​
legalName
string

Nombre legal de la organización.

Maximum string length: 256
​
parentOrganizationId
string<uuid> | null

Identificador único de la organización matriz.

​
doingBusinessAs
string | null

Nombre comercial de la organización.

Maximum string length: 256
​
legalDocument
string

Documento legal de la organización.

Maximum string length: 256
​
status
object

Objeto que contiene información sobre el estado.

​
address
object

Objeto que contiene información sobre la dirección de la organización.

​
metadata
object

Objeto que contiene pares clave-valor para agregar como metadatos, donde el campo name es la clave y el campo value es el valor. Por ejemplo, para agregar un centro de costos, usa 'costCenter': 'BR_11101997'.

​
createdAt
string<date-time>

Marca temporal de creación (UTC).

​
updatedAt
string<date-time>

Marca temporal de la última actualización (UTC).

​
deletedAt
string<date-time> | null

Marca temporal de eliminación lógica, si aplica (UTC).