# Trace Knowledge Center ## Docs - [Configure Connect Clients](https://docs.fairfood.org/Configure Connect Clients.md) - [Connect Library](https://docs.fairfood.org/Connect-Library.md) - [View / Print Invoice](https://docs.fairfood.org/Printinvoice.md) - [User Details Endpoint](https://docs.fairfood.org/api-references/accounts/get-accountsusers-.md): User Details endpoint allows you to retrieve detailed information about a user by providing their unique identifier (hashid). A GET request to this endpoint, along with the necessary authorization, returns key details such as user name, email, date of birth, phone number, and address. - [Update User Endpoint](https://docs.fairfood.org/api-references/accounts/patch-accountsusers-.md): API Update User endpoint allows you to update user information by making a PATCH request with the user's unique identifier (hashid). This endpoint enables you to modify specific user details, such as name, email, date of birth, phone number, and more. - [Login Endpoint](https://docs.fairfood.org/api-references/auth/api-to-login-user.md): The JWT Authentication endpoint enables users to obtain JSON Web Tokens (JWT) for secure authentication. Upon successful login, the API provides both an access token and a refresh token encoded as JWTs, allowing authenticated access to protected resources and token renewal for prolonged usage. - [Refresh Token Endpoint](https://docs.fairfood.org/api-references/auth/api-to-refresh-token.md): The Token Refresh endpoint allows users to refresh JSON Web Tokens (JWT) seamlessly. By providing a valid refresh token, users can obtain new JWT tokens, ensuring uninterrupted access to protected resources. - [Logout Endpoint](https://docs.fairfood.org/api-references/auth/post-authlogout.md): Logout endpoint is used to terminate a user session against a device, effectively logging the user out. By making a POST request to this endpoint and providing the necessary authorization, the user's session will be ended, ensuring secure access control. - [List Connect Cards Endpoint](https://docs.fairfood.org/api-references/catalogs/get-catalogsconnect-cards.md): Connect Cards endpoint allows you to retrieve a list of connect cards. A GET request to this endpoint, along with the necessary authorization, returns a paginated list of connect cards with details such as card ID, creation/update timestamps, display ID, and creator/updater information. - [List Currencies Endpoint](https://docs.fairfood.org/api-references/catalogs/get-catalogscurrencies.md): Currencies endpoint allows you to retrieve a list of currencies. A GET request to this endpoint, along with the necessary authorization, returns a paginated list of currencies with details such as currency ID, name, and code. - [List Premiums Endpoint](https://docs.fairfood.org/api-references/catalogs/get-catalogspremiums.md): Premiums endpoint allows you to retrieve a list of premiums connected with active company. A GET request to this endpoint, along with the necessary authorization, returns a paginated list of premiums with details such as premium ID, options, creation/update timestamps, category, name, type, amount,… - [List Products Endpoint](https://docs.fairfood.org/api-references/catalogs/get-catalogsproducts.md): Products endpoint allows you to retrieve a list of products connected with the active company. A GET request to this endpoint, along with the necessary authorization, returns a paginated list of products with details such as product ID, creation/update timestamps, name, and other relevant informatio… - [Create Premium Endpoint](https://docs.fairfood.org/api-references/catalogs/post-catalogspremiums.md): Create Premium endpoint allows you to create a new premium by making a POST request. Provide the required information in the request body, such as premium options, owner, name, type, amount, and other relevant details. - [Create Form Endpoint](https://docs.fairfood.org/api-references/forms/post-formsforms.md): The Create Form endpoint allows users to create a new form for transaction processing. Forms are used to add extra fields to store data while adding data to a resource. Different form types are available to specify the resources for the form. Field configurations can be added to customize the form's… - [Trace Connect Server](https://docs.fairfood.org/api-references/introduction.md) - [Trace Connect OAuth 2.0 provider](https://docs.fairfood.org/api-references/oauth/oauth-introduction.md) - [Company Details Endpoint](https://docs.fairfood.org/api-references/supply-chains/get-supply-chainscompanies-.md): Get Company Details endpoint allows you to retrieve detailed information about a specific company within the supply chain by making a GET request. Provide the hash ID of the company in the endpoint URL. - [List Entity Cards Endpoint](https://docs.fairfood.org/api-references/supply-chains/get-supply-chainsentity-cards.md): This API endpoint allows you to retrieve a list of entity cards within the supply chain system. By sending a GET request to the specified endpoint, you can obtain information about existing entity cards. - [List Farmers Endpoint](https://docs.fairfood.org/api-references/supply-chains/get-supply-chainsfarmers.md): This API endpoint allows you to retrieve a list of farmers within the supply chain system. By sending a GET request to the specified endpoint, you can obtain information about multiple farmer submissions. The API supports secure authentication through an API key included in the request header. - [Farmer Details Endpoint](https://docs.fairfood.org/api-references/supply-chains/get-supply-chainsfarmers-.md): This API endpoint enables you to retrieve detailed information about a specific farmer submission within the supply chain system. By sending a GET request to the specified endpoint with a unique identifier `hashid` for the farmer, you can access comprehensive details, including entity card informati… - [Update Company Details Endpoint](https://docs.fairfood.org/api-references/supply-chains/patch-supply-chainscompanies-.md): Update Company Details endpoint allows you to update information about a specific company within the supply chain by making a PATCH request. Provide the hash ID of the company in the endpoint URL and include the fields to be updated in the request body. - [Update Farmer Endpoint](https://docs.fairfood.org/api-references/supply-chains/patch-supply-chainsfarmers-.md): This API endpoint allows you to update an existing farmer submission within the supply chain system. By sending a PATCH request to the specified endpoint with a unique identifier `hashid` for the farmer, you can modify specific details of the submission. - [Create Company Endpoint](https://docs.fairfood.org/api-references/supply-chains/post-supply-chainscompanies.md): Create Company endpoint allows you to create a new company within the supply chain by making a POST request. Provide the required information in the request body, such as company details, address, contact information, and other relevant data. - [Add Company Member Endpoint](https://docs.fairfood.org/api-references/supply-chains/post-supply-chainscompany-members.md): Add Company Member endpoint allows you to add a new member to a specific company within the supply chain by making a POST request. Provide the required information in the request body, including user details and the type of membership. - [Add Company Product Endpoint](https://docs.fairfood.org/api-references/supply-chains/post-supply-chainscompany-products.md): The Add Company Product endpoint enables users to add a new or existing product associated with a company within a supply chain. This is achieved by sending a POST request to the specified URL, providing essential information such as product details, company affiliation, and optional forms and premi… - [Create Entity Card Endpoint](https://docs.fairfood.org/api-references/supply-chains/post-supply-chainsentity-cards.md): This API endpoint allows you to assign a new Connect card to Farmer or a Company within the supply chain system. By sending a POST request to the specified endpoint, you can add details for a new entity card. - [Create Farmer Endpoint](https://docs.fairfood.org/api-references/supply-chains/post-supply-chainsfarmers.md): This API endpoint allows you to seamlessly integrate and create a new submission for farmers within the supply chain system. Through this endpoint, you can capture essential information about farmers, including entity card details, form submissions, contact information, and additional demographic da… - [List Payment Transactions Endpoint](https://docs.fairfood.org/api-references/transactions/get-transactionspayment-transactions.md): The List Payment Transactions endpoint allows users to retrieve a paginated list of payment transactions. Each transaction includes details such as transaction ID, premium details, currency details, transaction type, amount, invoice information, and other relevant details. Pagination information is… - [Payment Transaction Detail Endpoint](https://docs.fairfood.org/api-references/transactions/get-transactionspayment-transactions-.md): The Get Payment Transaction Details endpoint allows users to retrieve detailed information about a specific payment transaction identified by the provided `hashid`. The response includes transaction details such as transaction ID, premium details, currency details, transaction type, amount, invoice… - [List Product Transactions Endpoint](https://docs.fairfood.org/api-references/transactions/get-transactionsproduct-transactions.md): This endpoint allows you to retrieve a list of product transactions. Each transaction includes details such as transaction payments, amount, currency, type, source and current quantity, submissions, card details, currency details, and additional information. The API response provides a paginated lis… - [Product Transaction Detail Endpoint](https://docs.fairfood.org/api-references/transactions/get-transactionsproduct-transactions-.md): This API endpoint enables users to access comprehensive information about specific product transactions within a supply chain system. Utilizing the this endpoint, users can retrieve detailed data, including unique identifiers, transaction metadata, and associated information for a targeted product t… - [Update Payment Invoice Endpoint](https://docs.fairfood.org/api-references/transactions/patch-transactionspayment-transactions-invoice.md): The Update Invoice for a Payment Transaction endpoint allows you to patch and update the invoice for a specific payment transaction identified by the `hashid` parameter. The request should include the invoice file as form data with the key invoice. The API responds with the updated transaction detai… - [Update Product Invoice Endpoint](https://docs.fairfood.org/api-references/transactions/patch-transactionsproduct-transactions-invoice.md): The Update Invoice for a Product Transaction endpoint allows you to patch and update the invoice for a specific product transaction identified by the `hashid` parameter. The request should include the invoice file in the form data. The API responds with the updated transaction details, including the… - [Create Payment Transaction Endpoint](https://docs.fairfood.org/api-references/transactions/post-transactionspayment-transactions.md): The Create Payment Transaction endpoint enables the creation of a new payment transaction. The request should include details such as transaction ID, premium details, currency details, payment amount, and other relevant information. Upon successful creation, the API responds with the newly created p… - [Create Product Transaction Endpoint](https://docs.fairfood.org/api-references/transactions/post-transactionsproduct-transactions.md): This API endpoint allows you to create a product transaction within the supply chain system. By sending a POST request to the specified endpoint, you can initiate a product transaction, including transaction payments and submission details. - [Clear data and logout](https://docs.fairfood.org/app_clear_data.md) - [App packages](https://docs.fairfood.org/app_packages.md): Google Analytics integrated within the Trace Mobile App allows for the collection of data, enabling the creation of reports that showcase user interaction with the app. - [User Profile](https://docs.fairfood.org/app_user_profile.md) - [Authentication](https://docs.fairfood.org/authentication.md): All the authentication and initial details fetch APIs are included in this section. - [Buy products](https://docs.fairfood.org/buy_products_app.md) - [Data Migration](https://docs.fairfood.org/data_migration.md) - [Brand](https://docs.fairfood.org/design_system_brand.md) - [Foundations](https://docs.fairfood.org/design_system_foundations.md) - [Farmer card](https://docs.fairfood.org/farmercard.md) - [Google Analytics - Trace Mobile App](https://docs.fairfood.org/google_analytics.md): Google Analytics integrated within the Trace Mobile App allows for the collection of data, enabling the creation of reports that showcase user interaction with the app. - [How login to Trace](https://docs.fairfood.org/how_login.md) - [Install & Update](https://docs.fairfood.org/install_app.md) - [Trace Knowledge Center](https://docs.fairfood.org/introduction.md): A hub for learning and mastering Trace. Access guides, references, and resources designed to help you discover and build with Trace. - [SSO Login](https://docs.fairfood.org/login_app.md) - [Mobile App Release Notes](https://docs.fairfood.org/mobile_app_release_notes.md) - [More features](https://docs.fairfood.org/more_features.md) - [Navigate](https://docs.fairfood.org/navigate.md) - [Onboarding Farmers](https://docs.fairfood.org/onboarding_farmers.md) - [Connect app Privacy Policy](https://docs.fairfood.org/privacy_policy.md) - [Trace Dashboard Release Notes](https://docs.fairfood.org/release_notes_dashboard.md): Dashboard will help Trace partners will be able to gain a better understanding of the farmers and businesses involved in their food chain, track the current location of products, and assess how well brand commitments are being fulfilled. - [Sell option](https://docs.fairfood.org/sell_products_app.md) - [Trace -Storytelling Interface](https://docs.fairfood.org/storytelling_interface.md) - [Storytelling Release Notes](https://docs.fairfood.org/storytelling_release_notes.md) - [Sync logic](https://docs.fairfood.org/sync_logic.md) - [Toolbox](https://docs.fairfood.org/toolbox.md): Our organization utilizes a comprehensive suite of tools to streamline workflows, enhance productivity, and ensure the delivery of high-quality projects. Each tool serves a specific purpose, and together, they enable us to manage every aspect of our operations efficiently. Below is a detailed overvi… - [Requests](https://docs.fairfood.org/trace _requests.md) - [Claims](https://docs.fairfood.org/trace_claims.md) - [Company profile](https://docs.fairfood.org/trace_company_profile.md) - [Trace Connect](https://docs.fairfood.org/trace_connect.md) - [Connections](https://docs.fairfood.org/trace_connections.md) - [Dashboard](https://docs.fairfood.org/trace_dashboard.md) - [Export tables](https://docs.fairfood.org/trace_export.md) - [Stock](https://docs.fairfood.org/trace_stock.md) - [Sync data](https://docs.fairfood.org/trace_sync.md) - [Transactions](https://docs.fairfood.org/trace_transactions.md) - [Trace Tech: 2023 Q3 Highlights](https://docs.fairfood.org/trace_update_q3_2023.md): During Q3, we shifted our gears into high gear for open-source-ready! We rolled up our sleeves, kicked off some epic housekeeping, and gave our tech a major upgrade. Additionally, we introduced some impressive new features. Perhaps the most thrilling accomplishment was the successful launch of a fu… - [Trace Tech: 2023 Q4 Highlights](https://docs.fairfood.org/trace_update_q4_2023.md) - [Trace Tech: 2023 Q1 Highlights ](https://docs.fairfood.org/trace_updates_q1_2023.md): The first quarter of 2023 has been a whirlwind of activity for our development team! In just three months, we managed to ship an impressive 493 tickets to production across six sprints and six releases. Our team has been tackling a variety of tasks, from designing and updating pages to squashing bug… - [Trace Tech: 2023 Q2 Highlights ](https://docs.fairfood.org/trace_updates_q2_2023.md): Q2 burst with energy as our Tech team rallied together in early May, igniting a dynamic spark. We fearlessly explored our tech archives, reviving forgotten treasures with a modern touch. - [Transactions](https://docs.fairfood.org/transactions_app.md) ## OpenAPI Specs - [openapi](https://docs.fairfood.org/openapi.yml)