Partners
Partners represent external organisations that a Consignly organisation interact with. Relationships are Client Partners (customers whose inventory is stored/shipped) and Carrier Partners (transport providers).
- Partner identity: Partners have an
Id,Code, and metadata (addresses, contact details, custom unit types, GS1 configuration). - Partner logos: Logos are managed at the partner level and used across the UI for branding and identification.
- Products & unit conversions: Client Partners can have associated products and product-level configuration. The Unit conversions and metric resolution (cascade vs compound) affect consignment metrics and charge calculations. Carrier Partners do not have products.
Partner Types
| Relationship | Value | Description |
|---|---|---|
| Client | 1 | Customers who store inventory in the warehouse |
| Carrier | 2 | Freight carriers who transport inventory |
AuthContext partner override: Many endpoints support partner-scoped tokens. When the caller's token is partner-scoped the API will override the
partnerIdpath parameter with the token'sAuthContext.PartnerId. This allows partners to call endpoints without specifying their own ID explicitly.