Tenants

A tenant is an top-level entity of Tirix. Think of tenants as customers of Tirix.

Security

As a security measure access to this node is restricted.

WARNING

You can only view and modify the tenant associated with your account. Access to lists are restricted.

TIP

You can directly access the tenant associated with your account using the edge /accounts/me/tenant.

Schema

Schema: Tenant

Property	Type	Description
id	ObjectId	Unique identifier
name	String	Name of tenant
database	String	Tenant database
active	Boolean	Determines if tenant is active
created	Date	Time when the tenant was created
updated	Date	Time when the tenant was last modified
billing_address	Address	Physical address where invoices should be sent
shipping_address	Address	Physical address where goods should be sent
owner	ObjectId	Account id owning the tenant

Get a list of tenants

If you want to retrieve a list of warehouse sites, use this GET request:

GET https://api.tirix.io/tenants

Get a tenant

If you want to fetch an individual warehouse site, use this GET request:

GET https://api.tirix.io/tenants/{tenant_id}

Create a new tenant

If you want to create a new warehouse site, use this POST request:

POST https://api.tirix.io/tenants

Modify a tenant

If you want to modify a specific warehouse site, use this PUT request:

PUT https://api.tirix.io/tenants/{tenant_id}

Delete a tenant

Tenants are persistent and can not be irreversibly deleted.

Edges

Accounts

If you want to fetch accounts for an individual tenant, use this GET request:

GET https://api.tirix.io/tenants/{tenant_id}/accounts

Warehouse sites

If you want to fetch warehouse sites for an individual tenant, use this GET request:

GET https://api.tirix.io/tenants/{tenant_id}/warehouse-sites