# Wholechain

> Index of the Wholechain documentation.

## User Guides

- [TEst page](https://docs.wholechain.com/test-page.md)
- [High-Level Navigation](https://docs.wholechain.com/user-guides/getting-started/navigation.md)
- [Introduction to Wholechain](https://docs.wholechain.com/user-guides/getting-started/introduction.md): Landing page with an overview of Wholechain's API for supply chain compliance, transparency, and efficiency, including key features and quick navigation to get started.
- [Introduction to Event-based Traceability](https://docs.wholechain.com/user-guides/getting-started/intro-to-event-based-traecability.md)
- [Authentication](https://docs.wholechain.com/api-reference/overview/api-authentication.md)
- [Trade Partner Invites](https://docs.wholechain.com/user-guides/master-data/trade-partner-invites.md)
- [Trade Partners](https://docs.wholechain.com/user-guides/master-data/trade-partners.md)
- [Trade Items](https://docs.wholechain.com/user-guides/master-data/trade-items.md)
- [Locations](https://docs.wholechain.com/user-guides/master-data/locations.md)
- [Core Data](https://docs.wholechain.com/user-guides/event-data/core-data.md)
- [Custom Data](https://docs.wholechain.com/user-guides/event-data/custom-data.md)
- [Personal Settings](https://docs.wholechain.com/user-guides/settings/personal-settings.md)
- [Account Settings](https://docs.wholechain.com/user-guides/settings/account-settings.md)
- [Brands](https://docs.wholechain.com/user-guides/settings/brands.md)
- [Supplier Portal](https://docs.wholechain.com/user-guides/settings/supplier-portal.md): coming soon...
- [Purchase Orders](https://docs.wholechain.com/user-guides/settings/purchase-orders.md)
- [Integrations](https://docs.wholechain.com/user-guides/settings/integrations.md): coming soon...
- [Users and Permissions](https://docs.wholechain.com/user-guides/settings/users-permissions.md)
- [Subscription and Billing](https://docs.wholechain.com/user-guides/settings/subscription-billing.md)
- [Data Element Library](https://docs.wholechain.com/user-guides/settings/data-element-library.md)
- [Template Attributes](https://docs.wholechain.com/user-guides/settings/template-attributes.md)
- [Master Data Settings](https://docs.wholechain.com/user-guides/settings/master-data-settings.md): coming soon...
- [External Identifier Manager](https://docs.wholechain.com/user-guides/settings/external-identifier-manager.md)
- [Bulk Upload Aliases](https://docs.wholechain.com/user-guides/settings/bulk-upload-aliases.md)
- [Data Policies and Frameworks](https://docs.wholechain.com/user-guides/settings/data-policies-frameworks.md)
- [Master Data Overview](https://docs.wholechain.com/user-guides/modules/master-data-overview.md)
- [Traceability](https://docs.wholechain.com/user-guides/modules/traceability.md)
- [PO Tracker](https://docs.wholechain.com/user-guides/modules/po-tracker.md)
- [Compliance](https://docs.wholechain.com/user-guides/modules/compliance.md)

## API Reference

- [Introduction](https://docs.wholechain.com/api-reference/overview/api-introduction.md)
- [Wholechain Data Structure Overview](https://docs.wholechain.com/api-reference/overview/understanding-the-data-structure.md)
- [Authentication](https://docs.wholechain.com/api-reference/overview/authentication.md): Secure your API requests with proper authentication methods, using API keys.
- [Errors and Status Codes](https://docs.wholechain.com/api-reference/overview/errors-status-codes.md): Handle common errors, interpret HTTP status codes, and troubleshoot issues effectively when integrating with the Wholechain API.
- [Create a Product](https://docs.wholechain.com/api-reference/products/product-creation.md)
- [Update a Product](https://docs.wholechain.com/api-reference/products/update-a-product.md)
- [List Products](https://docs.wholechain.com/api-reference/products/list-your-products.md)
- [Unit of Measurements and Packaging](https://docs.wholechain.com/api-reference/products/allowed-unit-of-measure.md): Products can be configured at different levels of detail depending on how the product needs to be represented. This page explains the difference between using a simple unit of measure VS defined unit of measures.
- [Create Trade Partners & Locations](https://docs.wholechain.com/api-reference/locations/create-location.md): Creates one or more standard locations together with their associated trade-partner information. Vessel-specific properties are documented in the separate Vessel API specification.
- [Update Trade Partners & Locations](https://docs.wholechain.com/api-reference/locations/update-a-location-trade-partner.md): Updates a standard location or its associated trade-partner information. The existing location id and TradePartner.Id identify the records being updated.
- [Create a Vessel](https://docs.wholechain.com/api-reference/locations/create-a-vessel.md): Creates one or more vessel locations together with their associated trade-partner, contact, and home-port information.
- [Update a Vessel](https://docs.wholechain.com/api-reference/locations/updating-a-vessel.md): Updates an existing vessel location. The location id and TradePartner.Id identify the records being updated and must remain unchanged.
- [List Locations](https://docs.wholechain.com/api-reference/locations/list-your-locations.md)
- [Events API Overview](https://docs.wholechain.com/api-reference/events/overview-of-the-events-api.md)
- [Understanding Event Responses](https://docs.wholechain.com/api-reference/events/understanding-event-responses.md)
- [Create a Commission Event](https://docs.wholechain.com/api-reference/events/create-a-commission-event.md): Create a Commission Event. The request example includes all fields documented for this event, including optional fields.
- [Create an Aggregation Event](https://docs.wholechain.com/api-reference/events/create-an-aggregation-event.md): Create an Aggregation Event. The request example includes all fields documented for this event, including optional fields.
- [Create a Disaggregation Event](https://docs.wholechain.com/api-reference/events/create-a-disaggregation-event.md): Create a Disaggregation Event. The request example includes all fields documented for this event, including optional fields.
- [Ship a Container](https://docs.wholechain.com/api-reference/events/shipping-a-container.md): Ships an existing container. ProductInstances must be an empty array because the products are identified through the container.
- [Ship a Lot](https://docs.wholechain.com/api-reference/events/shipping-a-lot.md): Ship a Lot. The request example includes all fields documented for this event, including optional fields.
- [Receive a Container](https://docs.wholechain.com/api-reference/events/receiving-a-container.md): Receive a Container. The request example includes all fields documented for this event, including optional fields.
- [Receive a Lot](https://docs.wholechain.com/api-reference/events/receiving-a-lot.md): Receive a Lot. The request example includes all fields documented for this event, including optional fields.
- [Create a Transform Event](https://docs.wholechain.com/api-reference/events/create-a-transform-event.md): Create a Transform Event. The request example includes all fields documented for this event, including optional fields.
- [Create an Observe Event](https://docs.wholechain.com/api-reference/events/create-an-observe-event.md): Create an Observe Event. The request example includes all fields documented for this event, including optional fields.
- [Create a Decommission Event](https://docs.wholechain.com/api-reference/events/create-a-decommission-event.md): Create a Decommission Event. The request example includes all fields documented for this event, including optional fields.
- [Event and Lot Custom Data](https://docs.wholechain.com/api-reference/events/custom-data.md): Creates a Commission event with event-level CustomProperties and lot-level MasterData. Location.Details and Product.Details can be supplied to create the location, trade partner, and product on the go.
- [Certifications](https://docs.wholechain.com/api-reference/events/certifications.md): Creates a Commission event with event-level CertificationList data. Location.Details and Product.Details can be supplied to create the location, trade partner, and product on the go. CertificationList applies to the complete event and must not be placed inside ProductInstances.
- [FSMA Compliance](https://docs.wholechain.com/api-reference/events/fsma-compliance.md): Creates a Commission event including the location and product master data required to create them on the go. For TlcSource, choose either reference data or master data.
- [Delete an Event](https://docs.wholechain.com/api-reference/events/delete-an-event.md)
- [Retrieve Event Details](https://docs.wholechain.com/api-reference/events/retrieve-event-details.md): LotSerial and PurchaseOrder are optional filters. You may provide either filter, both filters, or neither filter.
- [Update an Event](https://docs.wholechain.com/api-reference/events/update-an-event.md): Overrides an existing event using the complete documented Receive event payload.
- [Get Inventory](https://docs.wholechain.com/api-reference/inventory/get-inventory.md): Provide at least one of ProductIds or LocationIds. Each filter may contain one or more Wholechain IDs; provide both filters to return matching inventory only.
- [Documents Overview](https://docs.wholechain.com/api-reference/documents/documents-overview.md)
- [Upload your Documents ](https://docs.wholechain.com/api-reference/documents/document-upload.md): Uploads one supporting document to Wholechain using multipart/form-data. Document metadata is provided through X-Document-* headers. A successful upload returns a Document ID that can be attached to one or more events.
- [Attaching Documents to Events](https://docs.wholechain.com/api-reference/documents/adding-document-to-events.md): `DocumentIds` is an optional array of Document IDs returned when documents are uploaded with `POST /Integration/Documents`. It can be added to Commission, Receive, Ship, Transform, Aggregation, Disaggregation, Observe, and Decommission events. The event is created even if some document IDs cannot be found. `DocumentIds` is separate from `ReferenceDocumentId`, the traceability lot code (TLC) reference field.

## Help Center

- [Help Center](https://docs.wholechain.com/help-center.md)
- [How do I access the Wholechain dashboard?](https://docs.wholechain.com/help-center/faq/how-to-access-dashboard.md): Steps to log into the Wholechain dashboard.
- [Data Upload Failures](https://docs.wholechain.com/help-center/troubleshooting/data-upload-fail.md): Fix issues uploading supply chain data.
- [Inviting a Team Member](https://docs.wholechain.com/help-center/guides/invite-team-member.md): Quickly add new users to your Wholechain workspace.