Clients

Clients are the legal owners of warehoused stock and represents a corporate entity.

Single-client setup

In a 1pl configuration where you only warehouse and manage your own stock, only a single client should be present. This client will then be used for all warehouse operations.

Third-party logistics

In a 3pl configuration clients represent your customers - the entities for which you are providing warehouse services.

Schema

Schema: Client

Property	Type	Description
id	ObjectId	Unique identifier
created	Date	Time when the client was created
updated	Date	Time when the client was last modified
name	String	Client name
suspended	Boolean	Suspends all warehouse operations against client if true
archived	Boolean	Hide client by default in user interfaces if true
billing_address	Address	Physical address where invoices should be sent
shipping_address	Address	Physical address where goods should be sent
contacts	Array(Contact)	Contact information
image	Image	Client logo

Schema: Contact

Property	Type	Description
name	String	Contact name
email	String	Contact email address
phone	String	Contact phone number
type	String	Enum ["SUPPORT", "KAM", "BOARD", "IT", "MISC"]

Schema: Image

Property	Type	Description
resource_key	String	Internal resource identifier
url	String	Public image URL

Get a list of clients

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

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

Get a client

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

GET https://api.tirix.io/clients/{client_id}

Create a new client

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

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

Modify a client

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

PUT https://api.tirix.io/clients/{client_id}

Upsert a client image

If you want to insert or update a specific client image, use this POST request:

POST https://api.tirix.io/clients/{client_id}/image

Payload

Call should be made as multipart/form-data and uploading file should be in named parameter image.

File formats supported are: JPEG, PNG, WebP, AVIF, GIF, SVG and TIFF.

The uploaded image will be stored as a 300x200 lossless webp image and will automatically be scaled to fit.

Delete a client image

If you want to delete a specific client image, use this DELETE request:

DELETE https://api.tirix.io/clients/{client_id}/image

Delete a client

Clients are persistent and can not be irreversibly deleted.

TIP

You can suspend the client by setting its 'suspended' property to true. You can hide it in user interfaces by setting its 'archived' property to true.