Trace Knowledge Center

API Documentation

GitHub

Support

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.

Retrieve Farmers

List Farmers Endpoint

Card id

Updated On

Display ID

Is Active

Identifier of the buyer associated with the farmer. This indicates any buyer or customer linked to the farmer, if applicable.


Name of the city where the farmer resides. This is part of the farmer's address details.


City

Consent status of the farmer for data usage. This indicates whether the farmer has given consent for their data to be used.


Consent Status

Name of the country where the farmer resides. This is part of the farmer's address details.


Country

Date and time when the farmer information was created. This field indicates when the farmer record was initially added to the system.


Created On

Identifier of the user who created the farmer entry. This indicates the user responsible for adding the farmer information to the system.


Date of birth of the farmer. This is part of the farmer's personal details.


Date of Birth

Description or additional information about the farmer. This field allows for notes or comments to be added regarding the farmer.


Description

Email address of the farmer. This is used for electronic communication with the farmer.


Email Address

Information related to the Connect card of the farmer. 


First name of the farmer. This is part of the farmer's personal details.


First Name

Gender of the farmer. This is part of the farmer's personal details.


Gender

Name of the house or building where the farmer resides. This could be useful for address clarification.


House name

Unique identifier for the farmer. This identifier is used to distinguish one farmer from another in the system.


Identification number of the farmer. This could be a national identification number or any other form of identification.


Identification

URL to the photo of the farmer. This could be a link to a profile picture or any relevant image associated with the farmer.


Photo

Last name of the farmer. This is part of the farmer's personal details.


Last Name

Latitude coordinate of the farmer's location. This is used for geolocation purposes.


Latitude

Longitude coordinate of the farmer's location. This is used for geolocation purposes.


Longitude

Additional number for reference. It will be a auto generated value field.


Number

Phone number of the farmer. This is typically used for contacting the farmer if necessary.


Phone

Name of the province where the farmer resides. This is part of the farmer's address details.


Province

Reference number associated with the farmer. This could be a reference to another system or database.


Reference Number

Name of the street where the farmer resides. This is part of the farmer's address details.


Street

Name of the sub-province where the farmer resides. This is part of the farmer's address details.


Sub province

Submission details related to the farmer. This could include any extra fields metioned in form associated with the company.


Date and time when the farmer information was last updated. This field is automatically generated and cannot be modified directly.


Identifier of the user who last updated the farmer entry. This indicates the user responsible for the latest modifications to the farmer information.


Postal code or ZIP code of the area where the farmer resides. This is part of the farmer's address details.


Zipcode

Form Type

Default Value

Label

Label [en-uk]

Label [en-us]

Label [fr]

Label [ind]

Label [nl]

Options

Required

Field Type

Visibility

Date and time when the product was created.

Identifier of the user who created the product.

Product Description

URL to the image or photo of the product.

Product Image

Indicates whether the product is currently active.

Is active

Product Name

Premiums

Date and time when the product information was last updated.

Identifier of the user who last updated the product.

Field

Value

A viewset for viewing and editing Farmer instances.

Bearer

A hub for learning and mastering Trace. Access guides, references, and resources designed to help you discover and build with Trace.

How login to Trace

Dashboard

Company profile

Connections

Requests

Transactions

Stock

Claims

Export tables

Sync data

Install & Update

Login

Buy products

Sell option

Onboarding Farmers

User Profile

Clear data and logout

View / Print Invoice

Data Migration

More features

Trace -Storytelling Interface

Trace Connect

Sync logic

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.

App packages

Google Analytics - Trace Mobile App

All the authentication and initial details fetch APIs are included in this section.

Authentication

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.

Trace Dashboard Release Notes

Mobile App Release Notes

Storytelling Release Notes

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 bugs. Keep reading for a rundown of the exciting developments from the first quarter of the year.

Trace Tech: 2023 Q1 Highlights



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.

Trace Tech: 2023 Q2 Highlights



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 fully traceable nutmeg chain, complete with a captivating story curated by Trace, which is now available in supermarkets

Trace Tech: 2023 Q3 Highlights

Trace Tech: 2023 Q4 Highlights

Brand

Foundations

Connect app Privacy Policy

Introduction

Trace Connect Server

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.

Obtain JWT Token for Secure Access

Login Endpoint

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.

Refresh JWT Tokens for Continuous Access

Refresh Token Endpoint

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.

Terminate User Session

Logout Endpoint

Trace Connect OAuth 2.0 provider

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.

Retrieve Company Details

Company Details Endpoint

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 data.

Create a Farmer

Create Farmer Endpoint

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 information.

Retrieve Products

List Products Endpoint

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.

Make a Transaction

Create Product Transaction Endpoint

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 list of transactions with a count, next, previous, and an array of transaction results.

Trace Connect APIs

List Farmers Endpoint

Authorizations

Query Parameters

Response